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: |
    <span style="color:green">**Is this your first time here? Please check out our [introduction to Loket (API)](./Introduction)**</span>

    **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.
    We are looking into an alternative solution but for now please bear in mind.**


    # General
    The Loket.nl API is a RESTful API that exposes the data and features of the Loket.nl platform.
    The API accepts and returns JSON and can only be accessed by registered users.
    This documentation describes version 2 of the API.


    Are 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/) .

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

    [![Run in Postman](https://run.pstmn.io/button.svg)](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==)


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


    ## Environments
    The Loket.nl API has two different environments.
    The first environment is the "acceptance" environment which is used during development and returns test data.
    The second environment is the production environment which is to be used exclusively by approved applications.
    Both environments have their own URLs.
    * The acceptance environment can be accessed at https://api.loket-acc.nl/v2/ 
    * The production environment can be accessed at https://api.loket.nl/v2/

    ## OpenAPI documentation
    The endpoints are defined using the [OpenAPI 3.0 specification](https://github.com/OAI/OpenAPI-Specification),
    an industry-wide recognized standard for describing REST API's.

    __Please note:__ the endpoint documentation in this portal is not designed to be fully compatible with any automatic code generation tools.

    ## Change policy
    Over the course of time the API, and policies regarding the API can and will change. These changes are subject to the following guidelines.


    The following states hold true for the change policy for this API.

    * Loket.nl may sometimes introduce changes to the API and policies without advance notice. 
    * Loket.nl will try to inform users of any (breaking) change in advance.
    * Loket.nl will not be liable to you or any third party for such modifications or any adverse effects resulting from such modifications.
    * Loket.nl will try to avoid breaking changes as much as possible.

    ## Notification periods
    In regard to changes Loket.nl will strive to adhere to the following notification periods per type of change.
    Due to our versioning strategy at resource level this API has the possibility to run multiple versions of the same resource at one time.
    This allows for a window in which both the old and new version are available.
    Allowing for a gradual move to the new version. 

    | Type of change | Notification period | Support period old version |
    |------------------|---------------|---------------|
    | Non breaking change | 2 weeks | no new version |
    | Breaking change | 2 weeks | 6 months |
    | 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 | 


    We define a __non breaking__ change as follows. Any change to the API that does not cause failures in the applications that consume that API.
      * Introducing a new optional field to an existing resource
      * Introducing a new endpoint
      * Introducing a new operation (GET/PUT/POST/PATCH/DELETE)
      * Introducing a new optional parameter to an endpoint
      * Introducing a new version for a resource

    We define a __breaking change__ as follows. any change to an API that could potentially cause failures in the applications that consume that API.
      * Changing an existing JSON element (name, datatype, pattern, min/max length etc)
      * Removing a JSON element, endpoint, operation or parameter
      * Introducing a required JSON element
      * Introducing a required parameter to an endpoint
      * Passing the `obsoleteDate` of a version for a resource

    ## Versioning
    The Loket API uses two types of versioning. API versioning and resource versioning. 


    __API versioning__

    API 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.
    The API version is expected to change rarely as resource versioning is available to tackle most issues that need versioning.


    __Resource versioning__

    Every __JSON__ resource in the API is versioned via the Accept header.
    Allowing users of the API to influence what version is returned by setting the __mandatory__ accept header.
    The Accept header of request should have a value like `application/json;version=2018-01-01`. 
    Here, the second part of the header is used to refer to a specific version of the resource (2018-01-01).
    When calling the API it is possible to supply other dates rather than the exact resources version(s). 
    The businesslogic will select the version that is ON or BEFORE the given date.


    __For example:__ let's say there are two versions of a resource.
    These are 2018-01-01 and 2018-09-01. When calling the API you supply `application/json;version=2018-08-01`,
    in that case the API will use the version 2018-01-01 as its the nearest version in the past.  


    A response returns what `resourceVersion` was used and the 'obsoleteDate' of that version (in most cases this is NULL).
    The `obsoleteDate` indicates when the resources version will no longer be available via the API.
    With 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. 
    Allowing consumers of the resource 6 months to incorporate the change. Failure to do so will likely lead to failure in the implementation.

    In this developer portal you can find the service contracts for each, active, version of a resource.
    If, only if, there are multiple versions of a resource you can select the corresponding schema at that resource.

    ## Changelog
    The changelog for this API can be found [here](/Changelog).

    We strongly advise every user ofthe Loket REST API the subscribe to the email feed. Please check out the link on the changelog page.


    ## Legal notices
    Your use and access to the API is expressly conditioned on your compliance with the policies and restrictions related to the API. 
    If 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.  

    # Authentication
    Authorization 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/ 


    An authorized user is required to call the Loket API.

    __Note:__ This is an SSL-only API.

    __Note:__ Only TLS 1.2 is supported.

    | Environment          | TokenUrl                             | 
    | -------------------- | --------------------------------     | 
    | Acceptance           | https://oauth.loket-acc.nl/token     |
    | Production           | https://oauth.loket.nl/token         | 

    The following OAuth 2.0 flows are supported

    * Authorization Code flow (standard)
    * Refresh Token flow (extension on the Authorization Code Flow)
    * SSO flow (single sign-on)
    * Password flow

    ## Authorization code flow
    For most clients only the authorization_code (and thus refresh_token) will be supported. 
    Password grant type is not available for an external client.

    Please click the link below to see documentation on implementing the authorization code flow by external clients.

    __[Documentation on implementing the OAuth 2.0 authorization code flow](./OauthCode)__

    ## Refresh token flow
    After the authorization code flow yields a refresh token the refresh_token grant can be used to obtain an access/bearer token.
    The expire time of the access/bearer is also returned in the response please take this into account.
    With the refresh token flow the two factor step will be skipped.

    _Refresh token request example:_
    ```
    POST /token 
    grant_type=refresh_token&refresh_token={RefreshToken123}&client_Id={Client123}&client_secret={Secret123}
    ```

    _Refresh token response example:_
    ```json
    {
      "access_token": "JESJDhMBy0NPTM9SiXmYAzW45clOiQ5wSyDq3VWluguGNoKym4WPSiJoTDx67TQ",
      "token_type": "bearer",
      "expires_in": 3599,
      "refresh_token": "nGJtF6j6SeQbHAg",
      "two_factor_state": "None"
    }
    ```
    ## SSO flow
    The SSO (single sign-on) flow is based on OAuth 2.0 and requires the authorization flow to be completed.

    __For more information see:__ [Documentation on OAuth 2.0 SSO flow (for allowed clients)](./OauthSSO)


    __Please note:__ Among other things, it is possible to set up an SSO flow with both Loket en Werknemerloket.


    ## Password flow
    The password flow is typically NOT enabled for external clients. Only by exception will the password flow be enabled for security (and practical) reasons.

    _Password token request examples:_

    ```
    POST /token 
    grant_type=password&username={UserName123}&password={Password123}&client_Id={Client123}&client_secret={Secret123}
    ```
    Whether client_secret is required is dependent on the configuration of the client.

    # Authorization
    In this section we explain how the API authorization service determines if a request is authorized or not.

    ## The authorization entities

    | Entity | Description |
    | ----|----|
    | 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. |
    | User  | Is linked to a client (by performing the authorization code flow) and to a set of rechten (configuration in loket.nl)|
    | Module (product) | Enables certain functionality for the provider/employer. Modules can be enabled and disabled on both provider and employer level.|
    | 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|
    | 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.|
    | Rights (rechten) | Represent a group of activities.|

    ## The authorization process
    This flow assumes that both user and client are correctly configured and have access to the API. 

    1. Does the client have access to the activity?
    2. Does the user have access to the activity (through "recht")?
    3. Does the role have access to the activity (through "recht")?
    4. Does the provider/employer have the required module enabled for the activity?
    5. Does the user have access to the specified entity/ID?

    If 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).
    See the simplified authorization flow in the figure below.

    __Side note:__ users are linked to rechten and clients are linked to activities. This leaves room for discrepancies.
    Where 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.

    ![Loket authorization flow](../Authorization_flow_extern.png)

    ## Which users can use the API
    In almost all use-cases a Loket user should meet the following requirements to successfully setup an integration with that user.

    * The user must be a normal Loket user (so NOT a webservice user)
    * The user must be active (not blocked)
    * The user must have access to an employer 
      * For provider users this is done by assigning the user to the appropriate Team(s)
      * For employer users this is done by creating a user for or linking the user to the appropriate employer(s)
    * The user must have all appropriate rights
      * For provider users this is done by assigning appropriate rights via Team (or alternatively, directly to the user)
      * For employer users this is done by assigning appropriate rights to the user on employer level


    How to setup an integration is described in the [Authentication](../#section/Authentication) section.


    __Side notes:__ 
    * A user can have access to multiple employers with different rights per employer.
    * 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.
    * 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.

    # Data

    ## Data types
    The Loket.nl API accepts and returns JSON.
    Comform the [OpenAPI 3.0 specification](https://github.com/OAI/OpenAPI-Specification) the following data types are supported:
    * string
    * number (point is used to separate the integer part from the fractional part of a number)
    * integer (from OpenAPI)
    * object
    * array
    * boolean

    For most of these types, further specifications can be found in the `format` and `pattern` specifications in the service contract. 
    For example a `format: date` added to a string field indicates a valid date must be supplied.

    ## Metadata
    Fields of the type 'metadata' are fields for which the possible values can be acquired via the metadata endpoint of the resource.

    The metedata can be obtained by appending /metadata to the current endpoint.
    Using the GET verb the endpoint will return a JSON output with "all" the metadata for the given resource.
    In some cases multiple requests are needed to obtain all the metadata required, an exmple is given below.
    Typically different metadata endpoints are availalbe for the POST and the PUT endpoint.


    If metadata endpoints are avaible for a given endpoint/resource is mentioned in the description of that endpoint.

    ### Example response
    ```json
    {[
      {
          "field": "gender"
          options: [
              {
              "key": 1,
              "value":"Man"
              }
              {
              "key": 2,
              "value":"Vrouw"
              }
          ]
       },
       {
          "field": "country"
          options: [
              {
              "isoCode":"NL",
              "key": 530,
              "value":"Nederland"
              }
              {
              "isoCode":"BE",
              "key": 540,
              "value":"België"
              }
          ]
       }

    ]}

    ```


    ### Example urls

    __Acquiring  metadata for a POST Wage__
    ```
    /v2/providers/employers/employees/employments/{employmentId}/wages/metadata
    ```


    __Acquiring metadata for a PUT employee__
    ```
    /v2/providers/employers/employees/{employeeId}/metadata
    ```

    __Multiple requests to get all the metadata__

    In some cases there are metadata fields dependant on the selected value off another metadata field.
    Such 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.


    __For example:__

    __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.
    ```
    /v2/providers/employers/b869ded6-0659-4d8d-9a8a-f9e22425ec9c/jobapplicant/metadata
    ```

    __Request 2__, when a payrolladministration is selected perform a second request to acquire the payrolladministration specific metadata.
    ```
    /v2/providers/employers/jobapplicant/metadata/payrolladministration/54369214-14a1-41ab-892a-ea8438e34d6f
    ```

    __Request 3__, if a `payScale` is selected perform a third request to acquire the `payGrade` for that `payScale`.
    ```
    /v2/providers/employers/jobapplicant/metadata/salaryScaleType/54369214-14a1-41ab-892a-ea8438e34d6f
    ```

    ### Types of metadata
    We diferentiate between two types of metadata.

    1. Generic metadata field. The possible values for these fields are the same for every object no matter the provider, employer or employee etc. 
    Examples are: country, gender and nationality.
    2. Context specific metadata field. Examples of contexts are employer, payroll administration, provider and Loket.nl.
    In most cases the possible values for these field are resources in themselves and can be managed via the API. 
    If a metadata field is context specific the context is given in the description of the field. 
    Examples are: function, department and leaveType.


    __Note:__ some context specific metadata field can have multiple contexts. 

    For example: it is possible to define an export set in the provider context. 
    Making that export set available for all payroll administrations linked to the provider. 
    It is also possible to add an export set in the payroll administration context. That export set is only available to that payroll administration.
    When requesting the metadata of export set the user will be presented with a combined list of the provider and payroll administration export sets.

    ## Default values
    Many fields in the API have a default value. 
    In order to assist our API users to adhere to these defaults when creating a record (POST) we provide `/defaults` endpoints.

    * 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'). 
        * Whether an object within the resource is of the type metaData is indicated in the service contracts of that resource.
    * Context is determined by the GUID given in the Path. Examples are employer, payroll administration, employee and employment.
    * 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. 
      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.
    * The fields with no default will be set to null (even if the field is normally non-nullable).
    * Because the GET-object is returned the readonly fields are also returned.



    __An example endpoint would be:__

    ```
    /v2/providers/employers/employees/employments/{employmentId}/payrollperioddata/defaults
    ```

    __resulting in the following output:__

    ```json
    {
      "payrollPeriod": null,
      "shift": {
          "shiftNumber": 1
      },
      "payslipType": {
          "key": 2
      },
      "payslipText": null,
      "distributionUnit": {
          "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
      },
      "costCenter": {
          "key": 2
      },
      "costUnit": {
          "key": 2
      },
      "payrollComponents": []
    }
    ```

    __Note: Defaults endpoints are not yet generically available. If a Defaults endpoint exists this will be explicitly stated at that specific resource.__

    ## Date chains
    For most of the resources with a startDate and endDate a chain is maintained. Chain meaning that no records can overlap in time.
    Loket.nl has two types of chains.


    1) __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.

    2) __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.

    __Note:__ Chains are sometimes maintained with an additional context. For example, For `benefits and deductions` the broken chain is maintained per `payrollComponent`. 
    It is possible to have multiple active records for different `payrollComponent` never two active records for the same `payrollComponent`. 

    ## Custom export
    For 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.

    The `Accept` header supports the following 2 options:
    * CSV (text/csv;version=yyyy-MM-dd)
    * Excel (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;version=yyyy-MM-dd)


    The `X-ReportInput` is a custom header that requires a JSON object with the following structure as input.

    The filename without extension for the report 'FileNameWithoutExtension'
    delimiter --> The delimiter to be used. If not set "," is used
    Array of objects 'fields' with 2 fields:
    1. fieldName --> A Xpath reference to the field to be included in the export
    2. reportColumnName --> The column name for the field
    3. format --> Allows only for date formatting. e.g. dd-MM-yyyy for csv or dd-mm-yyyy for Excel (Excel only usses lowercase)
      3.1 For CSV: see https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings
      3.2 For Excel: https://support.microsoft.com/en-us/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68

    __Example `X-ReportInput`:__
    ```json
    {
    "fileNameWithoutExtension":"MyExport",
    "delimiter": ";",
    "fields":
      [
        {
          "fieldName": "startDate",
          "reportColumnName": "In dienst datum",
          "format": "dd-MM-yyyy"
        },
        {
          "fieldName": "personalDetails.firstName",
          "reportColumnName": "First Name"
        },
        {
          "fieldName": "personalDetails.lastName",
          "reportColumnName": "Last Name"
        }
      ]
    }
    ```
    __Example request:__
    ```CURL
    curl 
    --location 
    --request GET 'https://api.loket.nl/v2/providers/employers/155c8440-8ff6-4776-98db-5d2243a073e3/employees?orderby=employeeNumber' \
    --header 'Content-Type: application/json' \
    --header 'Accept: text/csv;version=2020-08-18' \
    --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' \
    ```


    # Request
    A request to the Loket.nl API consists of several components.
    Each of these components are discussed in this section.

    ## Base URL
    The API can be accessed at [https://api.loket.nl](https://api.loket.nl).
     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).

    ## Endpoints
    The 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).

    ## Path parameters

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

    ## Pagination

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

    The `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!

    The `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.

    Examples:

    * ```?pageNumber=2``` to return the second page
    * ```?pageSize=2``` to set the page size to two

    ## Filtering

    The API supports output filtering via the querystring parameter `filter`.

    Filtering is possible on all fields of the following datatypes:

    * string
    * integer
    * boolean
    * date-time
    * decimals

    The following operators are available:

    | Operator             | Description           | Example                         |
    | -------------------- | --------------------- | ------------------------------- |
    | Comparison Operators |                       |                                 |
    | eq                   | Equal                 | `city eq 'Redmond'`             |
    | ne                   | Not equal             | `city ne 'London'`              |
    | lk                   | Like                  | `city lk 'Lond'`                |
    | gt                   | Greater than          | `price gt 20`                   |
    | ge                   | Greater than or equal | `price ge 10`                   |
    | lt                   | Less than             | `price lt 20`                   |
    | le                   | Less than or equal    | `price le 100`                  |
    | Logical Operators    |                       |                                 |
    | and                  | Logical and           | `price le 200 and price gt 3.5` |
    | or                   | Logical or            | `price le 3.5 or price gt 200`  |

    Both 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.
    Do remember to URL encode the filter parameters.

    ### Examples

    All employments with a cancellation periode in months (the value 4 corresponds to months time unit).

    ```

    /v2/providers/employers/{{employerId}}/employees/employments?filter=cancellationPeriodTimeUnit.key eq 4

    ```

    All employments with no endDate.s

    ```

    /v2/providers/employers/{{employerId}}/employees/employments?filter=enddate eq null

    ```


    All employments with an end date less or equal to 2017-01-01

    ```

    /v2/providers/employers/{{employerId}}/employees/employments?filter=enddate le '2017-01-01'

    ```

    All employees with a employee number greater or equal 1 and less or equal 5

    ```

    /v2/providers/employers/{{employerId}}/employees?filter=employeeNumber ge 1 and employeeNumber le 5

    ```

    ## Ordering

    All Loket.nl API resources support ordering of the elements in the response on a specific field. 
    All fields can be used in ordering. 
    The 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.

    ### Examples

    Order employers by company name ascending

    ```

    /v2/providers/employers?orderBy=companyName

    ```

    Order employers by company name descending

    ```

    /v2/providers/employers?orderBy=-companyName

    ```

    Order employers by company name descending then by house number ascending

    ```

    /v2/providers/employers?orderBy=-companyName,address.houseNumber

    ```

    ## Headers

    In order to access the endpoints of the Loket.nl API, at least two request headers need to be set. 


    __1)__ the `Authorization` header is required in order to authorize the API call. 
    The value of this header is the word Bearer followed by a space and the access token acquired from the `/token` endpoint. 
    For example, if the acquired access token is `AbCdEf123456`, the value of the `Authorization` headers would be:

    ```
    Authorization: Bearer v69uloc3wcEFLePw2unot0FfAJfBocrvSwsrCo75JLUG7aE54zqSUnU
    ```

    __2)__ The second header that is required for proper usage of the API, is the `Accept` header.
    This 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.
    The value of the `Accept` header differs per endpoint is defined in the OpenAPI documentation of the endpoints.

    ```
    Accept: application/json;version=2018-01-01
    ```

    __3)__ In case of a PUT and sometimes a PATCH a third header is optional the if-match header. This header is used for concurrency control.
    Even though the header is optional we advise using this header on every PUT(PATCH) to ensure not losing data. 

    ```
    if-Match: aslkhas987da09s8udasd09a
    ```

    # Response

    In addition to the responses defined in the OpenAPI documentation, the Loket.nl API also provides additional fields that give more information about
    the response and the entities requested. This section will explain the full response given by the Loket.nl API by examining the example response below.


    Example 400 response


    ```json

    {
        "version": {
            "obsoleteDate": null,
            "versionNumber": "2018-01-01,
        },
        "messages": [
            {
                "code": 83,
                "id": null,
                "type": "BrokenBusinessRule",
                "description": "[field] has an invalid length",
                "properties": []
            }
        ],
        "_embedded": []
    }

    ```


    Example 200 response

    ```json

      {
          "totalSize": 1,
          "pageSize": 250,
          "totalPages": 1,
          "currentPage": 1,
          "version": {
              "obsoleteDate": null,
              "resourceVersion": "2018-01-01"
          },
          "messages": [],
          "content": {
              "id": "2b4c119c-527c-4cbb-a5b2-f3a11e4b76cx",
              ...
          }
      }

    ```

    ## Paging
    * `totalSize` has an integer value indicating the total number of entities irrespective of the page size.

    * `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.

    * `totalPages` has an integer value indicating the number of pages the requested collection holds given the specific pagesize.

    * `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.

    ## Version
    The `version` object provides information regarding the resource version of the entity requested.

      * `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.

      * `resourceVersion` shows the version of the requested entity. The resource version can be influenced by setting the `Accept` header.

    ## Messages
    The `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

      * `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`, `ConcurrencyViolation` and `NotFound` .
      
      * `description` has a string value that describes the message that has occurred.

      * `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.

      * `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. 
      
      * `properties` an array that can contain additional information regarding the message. Currently not yet fully implemented.

    * `_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.

    ## Headers
    * `etag` header is returned with every GET of a detail (single resource). This header is used for concurrency controle
    * `Expires` header is returned with every response to indicate how long a response can be cached
    * `Content-Disposition` header is used in case of downloads to provide a file name

    ## HTTP status codes

    The Loket.nl API supports the following http status codes.

    | Code | Is returned when |
    |------------------|---------------|
    | 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. |
    | 201 | The request to insert (POST) a new object was recived and processed succesfully. The response might still contain messages of the type warning.|
    | 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.  |
    | 401 | The bearer token provided in the authorization header is invalid. Do not retry the request until a new (valid) bearer token is acquired. |
    | 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. |
    | 404 | The resource requested was not found/does not exist. |
    | 409 | The give if-match header in a PUT request no longer represents the current state of the object. Please acquire the current state off the object, via a GET, and resolve the differences then try again. |
    | 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. |

    Note: 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.

    ## Caching
    The API uses the `Expires` header to indicate how long the item can be reused from the local cache.
    In most cases caching is not allowed for resources.
    Exceptions 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.
  title: Loket.nl API
  version: V2
  x-apisguru-categories:
    - enterprise
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/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').

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

      Please 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  
    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: 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. <br/> <br/>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).
    name: Organizational entity
  - description: |-
      NL: Variabele gegevens. Payroll period data (e.g. hours worked or specific bonus) relates to a single payroll period.

      There 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. <br/> <br/>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.
    name: Benefits and deductions
  - description: |
      NL: Beloning. Manage the wage of an employment <br/> <br/>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).
    name: Wage
  - description: |
      NL: Werktijd/ Arbeidstijd. Manage the working hours of an employment <br/> <br/>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).
    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.
       

      Normally, 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.
    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: 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: 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
        Get a list of all Achmea insurance contracts accessible to the current user
      operationId: GetAchmeaInsuranceContractsByUserId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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.
                              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-05-21
                              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: 2018-05-21
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get a list of all wage percentages (year-end bonus and holiday allowance percentages) for an Achmea insurance contract.
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-01-21
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        This endpoint allows the user to acquire the AOW date of an employee.
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2062-08-21
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get the authorizations of the application.
        We expose which activities are accessable by the application and which "rechten" and "producten" are required for the user/employer to enable those activities.
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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

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

        __Caching:__ This resource changes very infrequently and can be cached for a longer time.

        Get 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 <TOKEN>
            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

        This endpoint allows the user to acquire basic company information for a specific chamber of commerce number.
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <br/> Get a list of functions known by Data New Business. <br/>
      operationId: GetDataNewBusinessFunctions
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get 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. 
      operationId: GetDataNewBusinessToken
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <br/> 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     <br/>
      operationId: GetAddressByPostalCodeAndHouseNumber
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get a list of all providers accessible to the current user.
        Note: With the current functioning of Loket, the list will always contain 1 provider.

        Note: This endpoint is typically not relevant for most external parties, as the GetEmployerByUser endpoint will be much more relevant as starting point.
      operationId: GetProvidersByUser
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Delete an applicationset for the provider
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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


         Edit the details for an applicationset.
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              nullable: true
              properties:
                applicationSetType:
                  description: |
                    The type of the set 
                  enum:
                    - Products
                    - ExportDataTemplate
                    - Rights
                  nullable: false
                  readOnly: true
                  type: string
                data:
                  description: |
                    Contains an array of objects in json structure.
                  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
                  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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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 
                            enum:
                              - Products
                              - ExportDataTemplate
                              - Rights
                            nullable: false
                            readOnly: false
                            type: string
                          data:
                            description: |
                              Contains an array of objects in json structure.
                            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
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        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 


         Details of an authorization set. 
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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
            

        Delete an EmailIdentity for a provider. An EmailIdentity can only be deleted when it's not used in an emailTemplate.
      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 <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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
            

        Send an email to test the email identity configuration. 
      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 <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get a list of all employers accessible to the current user

        Please 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)
      operationId: GetEmployersByUserId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Mark announcements as read
      operationId: PatchAnnouncements
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Delete an existing benefit in kind type record
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get the details of an benefit in kind type
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        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/conceptemployees/import/{payrollAdministrationId}":
    patch:
      description: |
        __Activity name :__ PatchImportConceptEmployeesByPayrollAdministrationId

        __Metadata:__ No metadata

        Currently supported file is the payroll tax return XML (year 2022 or later).
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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
                                  example: 156
                                  format: int32
                                  minimum: 1
                                  nullable: true
                                  readOnly: true
                                  type: integer
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  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
                                  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
                                  example: 156
                                  format: int32
                                  minimum: 1
                                  nullable: true
                                  readOnly: true
                                  type: integer
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  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
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Acquire data on a specific paygrade, this consists of a list of paygrade values and their respective startDates.

        If a valid `date` parameter is included in the call, the list will consists of one item that is applicable for that date.
      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 <TOKEN>
            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.
                        example: 2018-01-01
                        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


         Get the details of a concept employee with fewer fields
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 1995-05-21
                                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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Edit the details of a concept employee with fewer fields.

        * Possible options (metadata) for generic fields of the type "metadata" can be acquired (GET) by adding `/metadata` to the URL.
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 1995-05-21
                      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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 1995-05-21
                                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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        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

        Delete a concept employee
      operationId: DeleteConceptEmployeeByConceptEmployeeId
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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


         Get the details of a concept employee
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-05-08
                            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: 1995-05-21
                                    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: 2019-05-31
                                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: 2019-01-01
                                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

                                  `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

                                  `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: 2012-05-01
                                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`

                                  `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`

                                  `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: 2019-06-01
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              startDate:
                                description: The date on which this employment starts.
                                example: 2019-01-01
                                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: 2018-05-08
                                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.
                                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.

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

                                  `distributionUnit` 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: 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.

                                  `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)
                                    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.

                                  `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. 
                                example: true
                                nullable: true
                                readOnly: false
                                type: boolean
                              grossWage:
                                description: |
                                  The gross wage for the employee
                                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.
                                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
                                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.
                                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. 

                                  `payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                                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.

                                  `payScale` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                                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.

                                  `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)
                                    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.

                                  `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. <br /> Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                                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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Edit the details of a concept employee

        * Possible options (metadata) for generic fields of the type "metadata" can be acquired (GET) by adding `/metadata` to the URL.
        * Possible options dependent on a specific payrollAdministration can be acquired via `../providers/employers/conceptemployees/metadata/payrollAdministration/{payrollAdministrationId}`.
        * Possible options for payGrade can be acquired via `../providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}`.

        A `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}`.


        __NonPayrollAdministrations__ For nonPayrollAdministrations the equivalent MetaData-endpoints are also available as described above. However NO specific defaults endpoint is available for the nonPayrollAdministration.
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-05-08
                  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: 1995-05-21
                          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: 2019-05-31
                      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: 2019-01-01
                      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

                        `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

                        `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: 2012-05-01
                      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`

                        `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`

                        `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: 2019-06-01
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    startDate:
                      description: The date on which this employment starts.
                      example: 2019-01-01
                      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: 2018-05-08
                      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.
                      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.

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

                        `distributionUnit` 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: 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.

                        `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)
                          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.

                        `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. 
                      example: true
                      nullable: true
                      readOnly: false
                      type: boolean
                    grossWage:
                      description: |
                        The gross wage for the employee
                      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.
                      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
                      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.
                      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. 

                        `payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                      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.

                        `payScale` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                      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.

                        `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)
                          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.

                        `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. <br /> Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                      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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-05-08
                            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: 1995-05-21
                                    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: 2019-05-31
                                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: 2019-01-01
                                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

                                  `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

                                  `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: 2012-05-01
                                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`

                                  `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`

                                  `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: 2019-06-01
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              startDate:
                                description: The date on which this employment starts.
                                example: 2019-01-01
                                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: 2018-05-08
                                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.
                                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.

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

                                  `distributionUnit` 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: 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.

                                  `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)
                                    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.

                                  `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. 
                                example: true
                                nullable: true
                                readOnly: false
                                type: boolean
                              grossWage:
                                description: |
                                  The gross wage for the employee
                                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.
                                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
                                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.
                                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. 

                                  `payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                                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.

                                  `payScale` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                                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.

                                  `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)
                                    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.

                                  `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. <br /> Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                                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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        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

        __Metadata:__ No metadata available. No defaults available.


        Initiate the proces to perform an assessment for a concept employee.
      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 <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get the citizen service number (BSN) of a concept employee.  BSN is separately authorized in Loket and is therefore designed to have its own activities.  
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Update the citizen service number (BSN) of a concept employee BSN is separately authorized in Loket and is therefore designed to have its own activities.
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        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

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

        The GUID of the conceptEmployee will be copied over to the GUID of the newly created Employee.

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


        If the employeeNumber is empty then this will be set automatically for the employee. (i.e. highest available number +1)

        __Additional functionality :__
        * 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.
        * This functionality can be applied by setting the optional X-ValidateOnly header to true
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get a list of documents within the concept employee's dossier (werknemerdossier). Via Qwoater.
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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
                                      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
                                      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
                                      example: 2018-05-08
                                      format: date
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    dateOfSubmission:
                                      description: |
                                        The time at which document was submitted. Qwoater: CreationDate
                                      example: 2018-05-08
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    description:
                                      description: |
                                        The description defined by the submitter. Qwoater: Docfield 33 Omschrijving
                                      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
                                      example: Bowls, John
                                      maxLength: 4000
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    year:
                                      description: |
                                        The year the document relates to. Qwoater: Docfield 86 Jaar
                                      example: 2017
                                      format: int32
                                      maximum: 9999
                                      minimum: 1000
                                      nullable: true
                                      readOnly: false
                                      type: integer
                                - properties:
                                    filename:
                                      description: |
                                        The name of the file. Qwoater: Filename
                                      example: BowlsJohn.pdf
                                      maxLength: 255
                                      minLength: 1
                                      nullable: false
                                      readOnly: false
                                      type: string
                            - properties:
                                isInitiateSignDocumentRequestPossible:
                                  description: |
                                    Indicates whether initiate sign document request is possible.
                                  example: true
                                  nullable: true
                                  readOnly: true
                                  type: boolean
                                signDocumentStatus:
                                  description: |
                                    Status of the signature.
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        __Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.

        Upload a document within the concept employee's dossier (werknemerdossier). Via Qwoater.
      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 <TOKEN>
            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
                          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
                          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
                          example: 2018-05-08
                          format: date
                          nullable: true
                          readOnly: false
                          type: string
                        dateOfSubmission:
                          description: |
                            The time at which document was submitted. Qwoater: CreationDate
                          example: 2018-05-08
                          format: date
                          nullable: false
                          readOnly: true
                          type: string
                        description:
                          description: |
                            The description defined by the submitter. Qwoater: Docfield 33 Omschrijving
                          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
                          example: Bowls, John
                          maxLength: 4000
                          nullable: true
                          readOnly: true
                          type: string
                        year:
                          description: |
                            The year the document relates to. Qwoater: Docfield 86 Jaar
                          example: 2017
                          format: int32
                          maximum: 9999
                          minimum: 1000
                          nullable: true
                          readOnly: false
                          type: integer
                    - properties:
                        filename:
                          description: |
                            The name of the file. Qwoater: Filename
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Delete a document in the concept employee dossier
      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 <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Download the file of a given concept employee dossier entry. Via Qwoater.
      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 <TOKEN>
            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

        Edit the details for a document in the concept employee dossier
      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 <TOKEN>
            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
                  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
                  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
                  example: 2018-05-08
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                dateOfSubmission:
                  description: |
                    The time at which document was submitted. Qwoater: CreationDate
                  example: 2018-05-08
                  format: date
                  nullable: false
                  readOnly: true
                  type: string
                description:
                  description: |
                    The description defined by the submitter. Qwoater: Docfield 33 Omschrijving
                  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
                  example: Bowls, John
                  maxLength: 4000
                  nullable: true
                  readOnly: true
                  type: string
                year:
                  description: |
                    The year the document relates to. Qwoater: Docfield 86 Jaar
                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        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

        Get audittrail for the document in the concept employee dossier.
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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
                              example: ""
                              nullable: true
                              readOnly: true
                              type: string
                            category:
                              description: |
                                Qwoater: DocumentType
                              example: ""
                              nullable: true
                              readOnly: true
                              type: string
                            dateOfAlert:
                              description: |
                                The time the declaration was submitted. Qwoater: Signaleringsdatum
                              example: 2018-05-08
                              format: date
                              nullable: true
                              readOnly: true
                              type: string
                            description:
                              description: |
                                Qwoater: Omschrijving
                              example: VSP004
                              nullable: true
                              readOnly: true
                              type: string
                            endUser:
                              description: |
                                Qwoater: EndUser
                              example: Hur, Ben
                              nullable: true
                              readOnly: true
                              type: string
                            event:
                              description: |
                                Qwoater: Event
                              example: Audittrail opgevraagd
                              nullable: false
                              readOnly: true
                              type: string
                            eventDate:
                              description: |
                                The time the declaration was submitted. Qwoater: AuditEventDate
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            role:
                              description: |
                                Qwoater: Role
                              example: Provider
                              nullable: false
                              readOnly: true
                              type: string
                            year:
                              description: |
                                Qwoater: Jaar
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        __Metadata:__ No metadata available.

        Delete the proces to sign a document for an Conceptemployee.
      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 <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        __Metadata:__ No metadata available.

        Retrieve the status of the signing.
      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 <TOKEN>
            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: <some warning>
                              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.
                                See [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: 2021-02-24T08:20:33.105668Z
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        __Metadata:__ No metadata available. Defaults are available by adding /defaults to the path.

        Initiate the proces to sign a document for an employment by one or more signers.
      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 <TOKEN>
            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        __Metadata:__ No metadata available.

        Report of the signature.
      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 <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        __Metadata:__ Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{conceptEmployeeId}/documenttemplates/generatedocument/metadata).

        Generate a document for an concept employee and store it in the employment dossier.  Via Qwoater.
      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 <TOKEN>
            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
                  example: VSP004
                  maxLength: 250
                  nullable: true
                  readOnly: false
                  type: string
                dateOfAlert:
                  description: |
                    The date at which document will alerted for cancellation. Qwoater: AlertDate
                  example: 2018-05-08
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                description:
                  description: |
                    The description defined by the submitter. Qwoater: Docfield 33 Omschrijving
                  example: Copy of id card
                  maxLength: 250
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                filename:
                  description: |
                    The name of the file. Qwoater: Filename
                  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.
                  example: 2020-05-08
                  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
                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        __Metadata:__ Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).

        Generate a document for an concept employee and receive a preview. Via Qwoater.
      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 <TOKEN>
            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
                  example: VSP004
                  maxLength: 250
                  nullable: true
                  readOnly: false
                  type: string
                dateOfAlert:
                  description: |
                    The date at which document will alerted for cancellation. Qwoater: AlertDate
                  example: 2018-05-08
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                description:
                  description: |
                    The description defined by the submitter. Qwoater: Docfield 33 Omschrijving
                  example: Copy of id card
                  maxLength: 250
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                filename:
                  description: |
                    The name of the file. Qwoater: Filename
                  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.
                  example: 2020-05-08
                  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
                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Delete a complete dossier, with all documents in it, for the concept employee
      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 <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get a count of the number of documents in the dossier. Via Qwoater.
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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
      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 <TOKEN>
            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)
                  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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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)
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get the details of a Concept employee with regards to ESS access
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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


        Delete an existing contract code record
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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


        Get the details of a contract code
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        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

        Delete an existing custom field record
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get the details of a custom field
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        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

        Delete an existing custom holiday record
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get the details of a custom holiday
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2021-01-01
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                date:
                  description: The date for the custom holiday.
                  example: 2021-01-01
                  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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2021-01-01
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        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

        Get the details of department
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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.
                            example: 2
                            format: int32
                            nullable: false
                            readOnly: false
                            type: integer
                          description:
                            description: |
                              The visible description (i.e. name) of the department.
                            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)
                            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.
                            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)
                                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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Edit the details for a department

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                description:
                  description: |
                    The visible description (i.e. name) of the department.
                  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)
                  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.
                  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)
                      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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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.
                            example: 2
                            format: int32
                            nullable: false
                            readOnly: false
                            type: integer
                          description:
                            description: |
                              The visible description (i.e. name) of the department.
                            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)
                            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.
                            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)
                                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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        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

        Delete an existing education further indication record
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get the details of an education further indication
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        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

        Delete an existing education type record
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get the details of an education type
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        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
            

        Delete an EmailIdentity for an employer. An EmailIdentity can only be deleted when it's not used in an emailTemplate.
      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 <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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
            

        Send an email to test the email identity configuration. 
      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 <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Delete an existing record from the contact history
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get the details of a contact 
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          contactMethod:
                            description: |
                              The method of contacting the person
                            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.
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.

        Edit the details of a contact history
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2020-03-16:
            schema:
              properties:
                contactDate:
                  description: The date on which the contact was initiated.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                contactMethod:
                  description: |
                    The method of contacting the person
                  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.
                  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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          contactMethod:
                            description: |
                              The method of contacting the person
                            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.
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        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

        Delete 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.
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get the details of an Absence Progress        
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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.<br/>
                            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: 2018-01-21
                            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.
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  Description of the type of work resumption.
                                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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.

        Edit the details of an absence progress
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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.<br/>
                  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: 2018-01-21
                  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.
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        Description of the type of work resumption.
                      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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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.<br/>
                            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: 2018-01-21
                            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.
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  Description of the type of work resumption.
                                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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        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

        Delete an existing absence (for an employee). If succesfull, this function also deletes the underlying absence progress records
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get the details of an Absence        
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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).
                            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:

                                1) Illness/sickness

                                2) "Vangnet" such as maternity leave, organ donation or adoption leave


                              Other absences such as Vacation days, unpayed leave and Personal leave are registerd using the leave endpoint
                            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: 2018-01-21
                                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: 2018-01-21
                            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: 2018-04-21
                            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`. 
                              When `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.
                                    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: 2018-01-21
                                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.
                                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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.

        Edit the details of am Absence
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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).
                  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:

                      1) Illness/sickness

                      2) "Vangnet" such as maternity leave, organ donation or adoption leave


                    Other absences such as Vacation days, unpayed leave and Personal leave are registerd using the leave endpoint
                  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: 2018-01-21
                      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: 2018-01-21
                  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: 2018-04-21
                  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`. 
                    When `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.
                          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: 2018-01-21
                      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.
                      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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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).
                            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:

                                1) Illness/sickness

                                2) "Vangnet" such as maternity leave, organ donation or adoption leave


                              Other absences such as Vacation days, unpayed leave and Personal leave are registerd using the leave endpoint
                            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: 2018-01-21
                                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: 2018-01-21
                            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: 2018-04-21
                            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`. 
                              When `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.
                                    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: 2018-01-21
                                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.
                                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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        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

        Get the contacts history for a specific absence (verzuimmelding).
      operationId: GetAbsenceContactsHistoryByAbsenceId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            contactMethod:
                              description: |
                                The method of contacting the person
                              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.
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL. 
      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 <TOKEN>
            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: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                contactMethod:
                  description: |
                    The method of contacting the person
                  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.
                  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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          contactMethod:
                            description: |
                              The method of contacting the person
                            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.
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        Get a list of absence progress (verzuimverloop) for a specific absence (verzuimmelding).
      operationId: GetAbsenceProgressByAbsenceId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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.<br/>
                              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: 2018-01-21
                              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.
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    Description of the type of work resumption.
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL. 

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

        Practically this means that a full recovery notification has been performed. 
      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 <TOKEN>
            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.<br/>
                  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: 2018-01-21
                  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.
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        Description of the type of work resumption.
                      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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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.<br/>
                            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: 2018-01-21
                            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.
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  Description of the type of work resumption.
                                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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        A succesfull call to this endpoint will close the absence and the underlying absence progress (with an empty endDate). 
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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.
                      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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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

        When performing a succesfull call to this endpoint, then the absence and the underlying absence progress will we reopend.
        Both `endOfAbsenceDate` and `endOfAbsenceReason` will be set to null
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Reopen an absence
      tags:
        - Absence
  "/providers/employers/employees/children/{childId}":
    delete:
      description: |
        __Activity name :__ DeleteChildByChildId

        Delete an existing child (for an employee)
      operationId: DeleteChildByChildId
      parameters:
        - description: The unique identifier of a child
          in: path
          name: childId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 child record
      tags:
        - Child
    get:
      description: |
        __Activity name :__ GetChildByChildId

        Get the details of a child        
      operationId: GetChildByChildId
      parameters:
        - description: The unique identifier of a child
          in: path
          name: childId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          dateOfBirth:
                            description: |
                              The date of birth
                            example: 1995-05-21
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          dateOfDeath:
                            description: |
                              The date of death
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          firstName:
                            description: |
                              The first name, given name, forename or Christian name as part of a persons personal name.
                            example: Susan
                            maxLength: 28
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          gender:
                            description: |
                              The gender
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: female
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            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
                          initials:
                            description: |
                              The initials
                            example: S.L.
                            maxLength: 6
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          lastName:
                            description: |
                              The last name, family name or surname as part of a persons personal name.
                            example: Bergen
                            maxLength: 25
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          prefix:
                            description: |
                              The prefix to the last name
                            example: van
                            maxLength: 10
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          residenceStatus:
                            description: |
                              Indicator to tell if the child is living at home or not. Use null if unknown.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                description: The key for the residence status
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: Is the child living with his parent
                                example: Living at home
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 child
      tags:
        - Child
    put:
      description: |
        __Activity name :__ PutChildByChildId

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.

        Edit the details of a child
      operationId: PutChildByChildId
      parameters:
        - description: The unique identifier of a child
          in: path
          name: childId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                dateOfBirth:
                  description: |
                    The date of birth
                  example: 1995-05-21
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                dateOfDeath:
                  description: |
                    The date of death
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                firstName:
                  description: |
                    The first name, given name, forename or Christian name as part of a persons personal name.
                  example: Susan
                  maxLength: 28
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                gender:
                  description: |
                    The gender
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: female
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  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
                initials:
                  description: |
                    The initials
                  example: S.L.
                  maxLength: 6
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                lastName:
                  description: |
                    The last name, family name or surname as part of a persons personal name.
                  example: Bergen
                  maxLength: 25
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                prefix:
                  description: |
                    The prefix to the last name
                  example: van
                  maxLength: 10
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                residenceStatus:
                  description: |
                    Indicator to tell if the child is living at home or not. Use null if unknown.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      description: The key for the residence status
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: Is the child living with his parent
                      example: Living at home
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
              type: object
        description: Child 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          dateOfBirth:
                            description: |
                              The date of birth
                            example: 1995-05-21
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          dateOfDeath:
                            description: |
                              The date of death
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          firstName:
                            description: |
                              The first name, given name, forename or Christian name as part of a persons personal name.
                            example: Susan
                            maxLength: 28
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          gender:
                            description: |
                              The gender
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: female
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            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
                          initials:
                            description: |
                              The initials
                            example: S.L.
                            maxLength: 6
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          lastName:
                            description: |
                              The last name, family name or surname as part of a persons personal name.
                            example: Bergen
                            maxLength: 25
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          prefix:
                            description: |
                              The prefix to the last name
                            example: van
                            maxLength: 10
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          residenceStatus:
                            description: |
                              Indicator to tell if the child is living at home or not. Use null if unknown.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                description: The key for the residence status
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: Is the child living with his parent
                                example: Living at home
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a child
      tags:
        - Child
  "/providers/employers/employees/contacts/{contactId}":
    delete:
      description: |
        __Activity name :__ DeleteContactByContactId

        Delete an existing Contact (for an employee)
      operationId: DeleteContactByContactId
      parameters:
        - description: The unique identifier of the employee contact detail
          in: path
          name: contactId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 contact
      tags:
        - Contact
    get:
      description: |
        __Activity name :__ GetContactByContactId  

        Get the details of a single contact
      operationId: GetContactByContactId
      parameters:
        - description: The unique identifier of the employee contact detail
          in: path
          name: contactId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          address:
                            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
                              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: 1234 AA
                                maxLength: 9
                                nullable: true
                                readOnly: false
                                type: string
                              street:
                                description: Streetname of the address
                                example: Voordijk
                                maxLength: 24
                                nullable: false
                                readOnly: false
                                type: string
                            type: object
                          description:
                            description: Describes the relationship of the contact to the employee
                            example: Moeder
                            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
                          name:
                            description: Name of the contact
                            example: Johanna Bakker
                            maxLength: 70
                            nullable: false
                            readOnly: false
                            type: string
                          particularities:
                            description: Extra information about the contact
                            example: Genoemd adres is een priveadres
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          phoneNumber:
                            description: The phone number of the contact
                            example: 013-12345678
                            maxLength: 15
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 single contact
      tags:
        - Contact
    put:
      description: |
        __Activity name :__ PutContactByContactId  

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.

        Edit the details of a contact
      operationId: PutContactByContactId
      parameters:
        - description: The unique identifier of the employee contact detail
          in: path
          name: contactId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                address:
                  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
                    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: 1234 AA
                      maxLength: 9
                      nullable: true
                      readOnly: false
                      type: string
                    street:
                      description: Streetname of the address
                      example: Voordijk
                      maxLength: 24
                      nullable: false
                      readOnly: false
                      type: string
                  type: object
                description:
                  description: Describes the relationship of the contact to the employee
                  example: Moeder
                  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
                name:
                  description: Name of the contact
                  example: Johanna Bakker
                  maxLength: 70
                  nullable: false
                  readOnly: false
                  type: string
                particularities:
                  description: Extra information about the contact
                  example: Genoemd adres is een priveadres
                  maxLength: 4000
                  nullable: true
                  readOnly: false
                  type: string
                phoneNumber:
                  description: The phone number of the contact
                  example: 013-12345678
                  maxLength: 15
                  nullable: true
                  readOnly: false
                  type: string
              type: object
        description: Contact 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          address:
                            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
                              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: 1234 AA
                                maxLength: 9
                                nullable: true
                                readOnly: false
                                type: string
                              street:
                                description: Streetname of the address
                                example: Voordijk
                                maxLength: 24
                                nullable: false
                                readOnly: false
                                type: string
                            type: object
                          description:
                            description: Describes the relationship of the contact to the employee
                            example: Moeder
                            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
                          name:
                            description: Name of the contact
                            example: Johanna Bakker
                            maxLength: 70
                            nullable: false
                            readOnly: false
                            type: string
                          particularities:
                            description: Extra information about the contact
                            example: Genoemd adres is een priveadres
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          phoneNumber:
                            description: The phone number of the contact
                            example: 013-12345678
                            maxLength: 15
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit a contact
      tags:
        - Contact
  "/providers/employers/employees/customfields/{employeeCustomFieldId}":
    delete:
      description: |
        __Activity name :__ DeleteEmployeeCustomFieldByEmployeeCustomFieldId

        Delete an existing custom field record
      operationId: DeleteEmployeeCustomFieldByEmployeeCustomFieldId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: employeeCustomFieldId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employee custom field record
      tags:
        - Employee custom field
    get:
      description: |
        __Activity name :__ GetEmployeeCustomFieldByEmployeeCustomFieldId

        Get the details of a custom field
      operationId: GetEmployeeCustomFieldByEmployeeCustomFieldId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: employeeCustomFieldId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            customField:
                              description: |
                                The custom field as defined at the employer-level.  The value can only be set in the POST (it cannot be changed with a PUT).
                              format: metadata
                              nullable: false
                              properties:
                                description:
                                  example: Shoe size
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                                id:
                                  description: The unique identifier of the custom field as defined at the employer level
                                  example: 025ce09b-bff2-4b05-bcf0-711a89da7c08
                                  format: uuid
                                  nullable: false
                                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                  readOnly: false
                                  type: string
                              readOnly: true
                              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
                            value:
                              description: The value for the custom field for the employee
                              example: "41"
                              maxLength: 255
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employee custom field
      tags:
        - Employee custom field
    put:
      description: |
        __Activity name :__ PutEmployeeCustomFieldByEmployeeCustomFieldId

        __Metadata :__ No metadata available for this endpoint
      operationId: PutEmployeeCustomFieldByEmployeeCustomFieldId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: employeeCustomFieldId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                customField:
                  description: |
                    The custom field as defined at the employer-level.  The value can only be set in the POST (it cannot be changed with a PUT).
                  format: metadata
                  nullable: false
                  properties:
                    description:
                      example: Shoe size
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                    id:
                      description: The unique identifier of the custom field as defined at the employer level
                      example: 025ce09b-bff2-4b05-bcf0-711a89da7c08
                      format: uuid
                      nullable: false
                      pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                      readOnly: false
                      type: string
                  readOnly: true
                  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
                value:
                  description: The value for the custom field for the employee
                  example: "41"
                  maxLength: 255
                  nullable: false
                  readOnly: false
                  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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          customField:
                            description: |
                              The custom field as defined at the employer-level.  The value can only be set in the POST (it cannot be changed with a PUT).
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Shoe size
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                              id:
                                description: The unique identifier of the custom field as defined at the employer level
                                example: 025ce09b-bff2-4b05-bcf0-711a89da7c08
                                format: uuid
                                nullable: false
                                pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                readOnly: false
                                type: string
                            readOnly: true
                            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
                          value:
                            description: The value for the custom field for the employee
                            example: "41"
                            maxLength: 255
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit an employee custom field record
      tags:
        - Employee custom field
  "/providers/employers/employees/educations/{employeeEducationId}":
    delete:
      description: |
        __Activity name :__ DeleteEducationByEducationId

        Delete an existing Education (for an employee)
      operationId: DeleteEducationByEducationId
      parameters:
        - description: The unique identifier of the employee education detail
          in: path
          name: employeeEducationId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 education
      tags:
        - Education
    get:
      description: |
        __Activity name :__ GetEducationByEducationId  

        Get the details of a single education
      operationId: GetEducationByEducationId
      parameters:
        - description: The unique identifier of the employee education detail
          in: path
          name: employeeEducationId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          educationLevel:
                            description: Indicates the level of the education.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: HBO
                                maxLength: 80
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          employeeCosts:
                            description: |
                              The costs of the education for the employee
                            example: 150
                            format: double
                            minimum: 0.01
                            nullable: true
                            readOnly: false
                            type: number
                          employerCosts:
                            description: |
                              The costs of the education for the employer
                            example: 850
                            format: double
                            minimum: 0.01
                            nullable: true
                            readOnly: false
                            type: number
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          endOfValidityDate:
                            description: The end date of the diploma validity . The date is up to and including.
                            example: 2023-12-31
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          furtherIndication:
                            format: metadata
                            nullable: true
                            properties:
                              code:
                                example: WO
                                nullable: false
                                readOnly: true
                                type: string
                              description:
                                example: Wetenschappelijk
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                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
                            type: object
                          hasDiploma:
                            description: Indicates whether the employee has graduated.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Onbekend
                                maxLength: 80
                                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
                          institute:
                            nullable: true
                            properties:
                              Name:
                                description: Name of the institute
                                example: Avans Hogeschool
                                maxLength: 70
                                nullable: false
                                readOnly: false
                                type: string
                              city:
                                description: City of the institute
                                example: Leiden
                                maxLength: 24
                                nullable: true
                                readOnly: false
                                type: string
                            type: object
                          name:
                            description: Name of the education
                            example: HBO accountancy
                            maxLength: 50
                            nullable: false
                            readOnly: false
                            type: string
                          particularities:
                            description: Extra information about the education
                            example: Van de opleiding is alleen een certificaat verkregen
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          startDate:
                            description: The date on which this education starts.
                            example: 2018-01-01
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          typeOfEducation:
                            description: The type of the education. `type of education` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: true
                            properties:
                              code:
                                example: WO
                                nullable: false
                                readOnly: true
                                type: string
                              description:
                                example: Wetenschappelijk
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                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
                            type: object
                          yearOfDiploma:
                            description: Year in which the diploma was aquired
                            example: 1995
                            format: int32
                            maximum: 2099
                            minimum: 1900
                            nullable: true
                            readOnly: false
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 single education
      tags:
        - Education
    put:
      description: |
        __Activity name :__ PutEducationByEducationId  

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.

        Edit the details of a education
      operationId: PutEducationByEducationId
      parameters:
        - description: The unique identifier of the employee education detail
          in: path
          name: employeeEducationId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                educationLevel:
                  description: Indicates the level of the education.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: HBO
                      maxLength: 80
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                employeeCosts:
                  description: |
                    The costs of the education for the employee
                  example: 150
                  format: double
                  minimum: 0.01
                  nullable: true
                  readOnly: false
                  type: number
                employerCosts:
                  description: |
                    The costs of the education for the employer
                  example: 850
                  format: double
                  minimum: 0.01
                  nullable: true
                  readOnly: false
                  type: number
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                endOfValidityDate:
                  description: The end date of the diploma validity . The date is up to and including.
                  example: 2023-12-31
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                furtherIndication:
                  format: metadata
                  nullable: true
                  properties:
                    code:
                      example: WO
                      nullable: false
                      readOnly: true
                      type: string
                    description:
                      example: Wetenschappelijk
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      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
                  type: object
                hasDiploma:
                  description: Indicates whether the employee has graduated.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Onbekend
                      maxLength: 80
                      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
                institute:
                  nullable: true
                  properties:
                    Name:
                      description: Name of the institute
                      example: Avans Hogeschool
                      maxLength: 70
                      nullable: false
                      readOnly: false
                      type: string
                    city:
                      description: City of the institute
                      example: Leiden
                      maxLength: 24
                      nullable: true
                      readOnly: false
                      type: string
                  type: object
                name:
                  description: Name of the education
                  example: HBO accountancy
                  maxLength: 50
                  nullable: false
                  readOnly: false
                  type: string
                particularities:
                  description: Extra information about the education
                  example: Van de opleiding is alleen een certificaat verkregen
                  maxLength: 4000
                  nullable: true
                  readOnly: false
                  type: string
                startDate:
                  description: The date on which this education starts.
                  example: 2018-01-01
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                typeOfEducation:
                  description: The type of the education. `type of education` is a metadata field within the employer context. Possible values can be managed by the user.
                  format: metadata
                  nullable: true
                  properties:
                    code:
                      example: WO
                      nullable: false
                      readOnly: true
                      type: string
                    description:
                      example: Wetenschappelijk
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      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
                  type: object
                yearOfDiploma:
                  description: Year in which the diploma was aquired
                  example: 1995
                  format: int32
                  maximum: 2099
                  minimum: 1900
                  nullable: true
                  readOnly: false
                  type: integer
              type: object
        description: Education 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          educationLevel:
                            description: Indicates the level of the education.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: HBO
                                maxLength: 80
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          employeeCosts:
                            description: |
                              The costs of the education for the employee
                            example: 150
                            format: double
                            minimum: 0.01
                            nullable: true
                            readOnly: false
                            type: number
                          employerCosts:
                            description: |
                              The costs of the education for the employer
                            example: 850
                            format: double
                            minimum: 0.01
                            nullable: true
                            readOnly: false
                            type: number
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          endOfValidityDate:
                            description: The end date of the diploma validity . The date is up to and including.
                            example: 2023-12-31
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          furtherIndication:
                            format: metadata
                            nullable: true
                            properties:
                              code:
                                example: WO
                                nullable: false
                                readOnly: true
                                type: string
                              description:
                                example: Wetenschappelijk
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                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
                            type: object
                          hasDiploma:
                            description: Indicates whether the employee has graduated.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Onbekend
                                maxLength: 80
                                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
                          institute:
                            nullable: true
                            properties:
                              Name:
                                description: Name of the institute
                                example: Avans Hogeschool
                                maxLength: 70
                                nullable: false
                                readOnly: false
                                type: string
                              city:
                                description: City of the institute
                                example: Leiden
                                maxLength: 24
                                nullable: true
                                readOnly: false
                                type: string
                            type: object
                          name:
                            description: Name of the education
                            example: HBO accountancy
                            maxLength: 50
                            nullable: false
                            readOnly: false
                            type: string
                          particularities:
                            description: Extra information about the education
                            example: Van de opleiding is alleen een certificaat verkregen
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          startDate:
                            description: The date on which this education starts.
                            example: 2018-01-01
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          typeOfEducation:
                            description: The type of the education. `type of education` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: true
                            properties:
                              code:
                                example: WO
                                nullable: false
                                readOnly: true
                                type: string
                              description:
                                example: Wetenschappelijk
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                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
                            type: object
                          yearOfDiploma:
                            description: Year in which the diploma was aquired
                            example: 1995
                            format: int32
                            maximum: 2099
                            minimum: 1900
                            nullable: true
                            readOnly: false
                            type: integer
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit a Education
      tags:
        - Education
  /providers/employers/employees/employments/WageProposals:
    patch:
      description: |
        __Activity name :__ PatchWageProposalsByWageProposalId

        Accept or reject wage proposals
      operationId: PatchWageProposalsByWageProposalId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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:
                  action:
                    description: |-
                      The action to perform on the wage proposal resulting in a change of `status`
                      The following transitions are allowed
                      1. Voorgesteld --> Accept or reject
                      2. Goedgekeurd ---> No changes possible
                      3. Afgekeurd ---> No changes possible
                      5. Niet verwerkbaar ---> No changes possible
                    enum:
                      - accept
                      - reject
                    nullable: false
                    readOnly: false
                    type: string
                  id:
                    description: The unique identifier (a 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: array
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Accept or reject wage proposals
      tags:
        - Wage proposal
  "/providers/employers/employees/employments/abpfunds/{abpFundId}":
    delete:
      description: |
        __Activity name :__ DeleteAbpFundByAbpFundId

        Delete an existing abp fund record.
      operationId: DeleteAbpFundByAbpFundId
      parameters:
        - description: The unique identifier of the abp fund
          in: path
          name: abpFundId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 abp fund record
      tags:
        - Abp funds
    get:
      description: |
        __Activity name :__ GetAbpFundByAbpFundId

        Get the details of an abp fund
      operationId: GetAbpFundByAbpFundId
      parameters:
        - description: The unique identifier of the abp fund
          in: path
          name: abpFundId
          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 <TOKEN>
            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:
              examples:
                example1:
                  value:
                    content:
                      deviations: null
                      endDate: 2018-10-23
                      fixedContribution: null
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
                example2:
                  value:
                    content:
                      deviations:
                        employmentContributionPercentage: "1.0000"
                        totalContributionPercentage: "12.0007"
                      endDate: 2018-10-23
                      fixedContribution: null
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
                example3:
                  value:
                    content:
                      deviations: null
                      endDate: 2018-10-23
                      fixedContribution:
                        employmentContribution: "1789.00"
                        totalContribution: "2569.00"
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            deviations:
                              description: |-
                                Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`.

                                Deviating is done on either all the fields or none.

                                __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                              nullable: true
                              properties:
                                employmentContributionPercentage:
                                  description: |-
                                    Deviating employment contribution percentage. This value will overrule the value of the selected `fund`. Indicates percentage wise how much the employment has to contribute to the payment of the "fund" contribution.

                                    __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                                  example: 11
                                  format: double
                                  maximum: 100
                                  minimum: 0
                                  nullable: false
                                  pattern: ^(\d{1,3})(\.\d{1,3})?$
                                  readOnly: false
                                  type: number
                                totalContributionPercentage:
                                  description: |-
                                    Deviating total contribution percentage. This value will overrule the value of the selected `fund`. The difference between `employmentContributionPercentage` and `totalContributionPercentage` will be paid by the employer.

                                    __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                                  example: 12.007
                                  format: double
                                  maximum: 100
                                  minimum: 0
                                  nullable: false
                                  pattern: ^(\d{1,3})(\.\d{1,3})?$
                                  readOnly: false
                                  type: number
                              readOnly: false
                              type: object
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              format: date
                              nullable: true
                              readOnly: false
                              type: string
                            fixedContribution:
                              description: |-
                                With the underlying elements fixed values (money) can be set as the result of the Fund calculation.  In doing so the actual calculation for the `fund` will no longer take place as the outcome is fixed. This has the side effect that the "grondslag" is no longer calculated.  In the data exchange with certain parties the "grondslag" has to be communicated allongside the contribution.  In those cases do not use this option as the calculation is disabled.

                                Setting a fixed contribution is done on either all the fields or none.

                                __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                              nullable: true
                              properties:
                                employmentContribution:
                                  description: |-
                                    The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates.

                                    __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0.00 up to 9999.99
                                  example: 1789
                                  format: double
                                  maximum: 99999999.99
                                  minimum: 0
                                  nullable: false
                                  pattern: ^(\d{1,8})(\.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                totalContribution:
                                  description: |-
                                    The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates.

                                    __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0 up to 9999.99
                                  example: 2569
                                  format: double
                                  maximum: 99999999.99
                                  minimum: 0
                                  nullable: false
                                  pattern: ^(\d{1,8})(\.\d{1,2})?$
                                  readOnly: false
                                  type: number
                              readOnly: false
                              type: object
                            fund:
                              format: metadata
                              properties:
                                description:
                                  description: |
                                    The description of the fund
                                  example: Ouderdomspensioen
                                  maxLength: 255
                                  minLength: 1
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  description: |
                                    The key for the fund
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              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
                            startDate:
                              description: |-
                                The date on which this fund starts.

                                A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time.
                              example: 2018-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 abp fund
      tags:
        - Abp funds
    put:
      description: |
        __Activity name :__ PutAbpFundByAbpFundId

        __Metadata :__ Possible options for fields of the type "metadata" can be acquired (GET) by adding `/metadata` to the PUT URL.
      operationId: PutAbpFundByAbpFundId
      parameters:
        - description: The unique identifier of the abp fund
          in: path
          name: abpFundId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            examples:
              example1:
                value:
                  deviations: null
                  endDate: 2018-10-23
                  fixedContribution: null
                  startDate: 2018-01-01
              example2:
                value:
                  deviations:
                    employmentContributionPercentage: "11.0000"
                    totalContributionPercentage: "12.0007"
                  endDate: 2018-10-23
                  fixedContribution: null
                  startDate: 2018-01-01
              example3:
                value:
                  deviations: null
                  endDate: 2018-10-23
                  fixedContribution:
                    employmentContribution: "1789.00"
                    totalContribution: "2569.00"
                  startDate: 2018-01-01
            schema:
              properties:
                deviations:
                  description: |-
                    Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`.

                    Deviating is done on either all the fields or none.

                    __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                  nullable: true
                  properties:
                    employmentContributionPercentage:
                      description: Deviating employment contribution percentage. This value will overrule the value of the selected `fund`. Indicates percentage wise how much the employment has to contribute to the payment of the "fund" contribution.
                      example: 11
                      format: double
                      maximum: 100
                      minimum: 0
                      nullable: false
                      pattern: ^(\d{1,2})(\.\d{1,3})?$
                      readOnly: false
                      type: number
                    totalContributionPercentage:
                      description: Deviating total contribution percentage. This value will overrule the value of the selected `fund`. The difference between `employmentContributionPercentage` and `totalContributionPercentage` will be paid by the employer.
                      example: 12.007
                      format: double
                      maximum: 100
                      minimum: 0
                      nullable: false
                      pattern: ^(\d{1,2})(\.\d{1,3})?$
                      readOnly: false
                      type: number
                  readOnly: false
                  type: object
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                fixedContribution:
                  description: |-
                    With the underlying elements fixed values (money) can be set as the result of the Fund calculation.  In doing so the actual calculation for the `fund` will no longer take place as the outcome is fixed. This has the side effect that the "grondslag" is no longer calculated.  In the data exchange with certain parties the "grondslag" has to be communicated allongside the contribution.  In those cases do not use this option as the calculation is disabled.

                    Setting a fixed contribution is done on either all the fields or none.

                    __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                  nullable: true
                  properties:
                    employmentContribution:
                      description: The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates.
                      example: 1789
                      format: double
                      maximum: 99999999.99
                      minimum: 0
                      nullable: false
                      pattern: ^(\d{1,8})(\.\d{1,2})?$
                      readOnly: false
                      type: number
                    totalContribution:
                      description: The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates.
                      example: 2569
                      format: double
                      maximum: 99999999.99
                      minimum: 0
                      nullable: false
                      pattern: ^(\d{1,8})(\.\d{1,2})?$
                      readOnly: false
                      type: number
                  readOnly: false
                  type: object
                fund:
                  format: metadata
                  properties:
                    description:
                      description: |
                        The description of the fund
                      example: Ouderdomspensioen
                      maxLength: 255
                      minLength: 1
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      description: |
                        The key for the fund
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                  readOnly: true
                  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
                startDate:
                  description: |-
                    The date on which this fund starts.

                    A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
        required: true
      responses:
        "200":
          content:
            application/json;version=2018-01-01:
              examples:
                example1:
                  value:
                    content:
                      deviations: null
                      endDate: 2018-10-23
                      fixedContribution: null
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
                example2:
                  value:
                    content:
                      deviations:
                        employmentContributionPercentage: "1.0000"
                        totalContributionPercentage: "12.0007"
                      endDate: 2018-10-23
                      fixedContribution: null
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
                example3:
                  value:
                    content:
                      deviations: null
                      endDate: 2018-10-23
                      fixedContribution:
                        employmentContribution: "1789.00"
                        totalContribution: "2569.00"
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          deviations:
                            description: |-
                              Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`.

                              Deviating is done on either all the fields or none.

                              __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                            nullable: true
                            properties:
                              employmentContributionPercentage:
                                description: |-
                                  Deviating employment contribution percentage. This value will overrule the value of the selected `fund`. Indicates percentage wise how much the employment has to contribute to the payment of the "fund" contribution.

                                  __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                                example: 11
                                format: double
                                maximum: 100
                                minimum: 0
                                nullable: false
                                pattern: ^(\d{1,3})(\.\d{1,3})?$
                                readOnly: false
                                type: number
                              totalContributionPercentage:
                                description: |-
                                  Deviating total contribution percentage. This value will overrule the value of the selected `fund`. The difference between `employmentContributionPercentage` and `totalContributionPercentage` will be paid by the employer.

                                  __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                                example: 12.007
                                format: double
                                maximum: 100
                                minimum: 0
                                nullable: false
                                pattern: ^(\d{1,3})(\.\d{1,3})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          fixedContribution:
                            description: |-
                              With the underlying elements fixed values (money) can be set as the result of the Fund calculation.  In doing so the actual calculation for the `fund` will no longer take place as the outcome is fixed. This has the side effect that the "grondslag" is no longer calculated.  In the data exchange with certain parties the "grondslag" has to be communicated allongside the contribution.  In those cases do not use this option as the calculation is disabled.

                              Setting a fixed contribution is done on either all the fields or none.

                              __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                            nullable: true
                            properties:
                              employmentContribution:
                                description: |-
                                  The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates.

                                  __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0.00 up to 9999.99
                                example: 1789
                                format: double
                                maximum: 99999999.99
                                minimum: 0
                                nullable: false
                                pattern: ^(\d{1,8})(\.\d{1,2})?$
                                readOnly: false
                                type: number
                              totalContribution:
                                description: |-
                                  The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates.

                                  __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0 up to 9999.99
                                example: 2569
                                format: double
                                maximum: 99999999.99
                                minimum: 0
                                nullable: false
                                pattern: ^(\d{1,8})(\.\d{1,2})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          fund:
                            format: metadata
                            properties:
                              description:
                                description: |
                                  The description of the fund
                                example: Ouderdomspensioen
                                maxLength: 255
                                minLength: 1
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                description: |
                                  The key for the fund
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            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
                          startDate:
                            description: |-
                              The date on which this fund starts.

                              A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time.
                            example: 2018-01-01
                            format: date
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit a abp fund record
      tags:
        - Abp funds
  "/providers/employers/employees/employments/attachmentsofearnings/{attachmentOfEarningsId}":
    delete:
      description: |
        __Activity name :__ DeleteAttachmentOfEarningsByAttachmentOfEarningsId

        Delete an existing attachment of earnings record
      operationId: DeleteAttachmentOfEarningsByAttachmentOfEarningsId
      parameters:
        - description: The unique identifier of a record
          in: path
          name: attachmentOfEarningsId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 attachment of earnings record
      tags:
        - Attachment of earnings
    get:
      description: |
        __Activity name :__ GetAttachmentOfEarningsByAttachmentOfEarningsId

        Get the details of an attachment of earnings record
      operationId: GetAttachmentOfEarningsByAttachmentOfEarningsId
      parameters:
        - description: The unique identifier of a record
          in: path
          name: attachmentOfEarningsId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          beneficiary:
                            description: Information regarding the beneficiary coresponding with the bank account number
                            nullable: false
                            properties:
                              city:
                                description: |
                                  City name of beneficiary
                                example: Rome
                                maxLength: 24
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              name:
                                description: |
                                  Name of the beneficiary
                                example: Ben Hur
                                maxLength: 70
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                            type: object
                          creditor:
                            description: Information regarding the creditor
                            nullable: false
                            properties:
                              priority:
                                description: The priority of a creditor within the type of creditors. 0 is the highest priority followed by 1 etc. Priority dictates the order in which creditor receives their payment.  The amount of earnings that can be used for payments can be limited (see attachment-exempt threshold).  The system will then divide the available earnings starting with the creditor with the highest priority.  If all available earnings are spend all other attachments will not receive payment until the time that earnings are available to meet them.
                                example: 0
                                format: int32
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                              type:
                                description: The type of creditor. A preferent creditor has priority over non-preferent creditors.
                                format: metadata
                                properties:
                                  key:
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Preferente schuldeiser
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                            type: object
                          description1:
                            description: |
                              Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: Savings to different account
                            maxLength: 32
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          description2:
                            description: |
                              Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: from net wage
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          descriptionPayslip:
                            description: |
                              This value is shown on the payslip to identify the attachment.
                            example: payment to creditor x
                            maxLength: 14
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          endDate:
                            description: |
                              The end date of the record
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          fixedPaymentPerPayrollPeriod:
                            description: |-
                              Set a fixed sum to be payed every payroll period.

                              __Note:__ If left empty the "available" earnings will be calculated in the payroll run by subtracting the protected earnings threshold (beslagvrijevoet) from the netwage. This method can lead to variable payments per payroll period.
                            example: 50
                            format: double
                            maximum: 99999999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,8})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          iban:
                            description: |
                              International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                            example: NL52ABNA0424968264
                            maxLength: 35
                            minLength: 1
                            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
                          startDate:
                            description: |
                              Start date of this record

                              __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for splitting from net salary at that date (based on the start- and enddate).
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          totalAmount:
                            properties:
                              owed:
                                description: The total amount to be paid to the creditor
                                example: 320
                                format: double
                                maximum: 99999999.99
                                minimum: 0.01
                                nullable: false
                                pattern: ^(\d{1,8})(\.\d{1,2})?$
                                readOnly: false
                                type: number
                              paid:
                                properties:
                                  inApprovedPayrollRuns:
                                    description: The total amount registerd in payroll run(s) with the status "approved".
                                    example: 50
                                    format: double
                                    maximum: 99999999.99
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,8})(\.\d{1,2})?$
                                    readOnly: true
                                    type: number
                                  inOpenPayrollRun:
                                    description: |-
                                      The total amount registerd in payroll run(s) with the status "open". 

                                      Note that open payroll runs are not final until they get approved, changes are posible until then.
                                    example: 0
                                    format: double
                                    maximum: 99999999.99
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,8})(\.\d{1,2})?$
                                    readOnly: true
                                    type: number
                                readOnly: true
                                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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the details of an attachment of earnings record
      tags:
        - Attachment of earnings
    put:
      description: |
        __Activity name :__ PutAttachmentOfEarningsByAttachmentOfEarningsId

        Update the details of a single attachment of earnings record

        __Metadata :__ Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the URL
      operationId: PutAttachmentOfEarningsByAttachmentOfEarningsId
      parameters:
        - description: The unique identifier of a record
          in: path
          name: attachmentOfEarningsId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                beneficiary:
                  description: Information regarding the beneficiary coresponding with the bank account number
                  nullable: false
                  properties:
                    city:
                      description: |
                        City name of beneficiary
                      example: Rome
                      maxLength: 24
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                    name:
                      description: |
                        Name of the beneficiary
                      example: Ben Hur
                      maxLength: 70
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                  type: object
                creditor:
                  description: Information regarding the creditor
                  nullable: false
                  properties:
                    priority:
                      description: The priority of a creditor within the type of creditors. 0 is the highest priority followed by 1 etc. Priority dictates the order in which creditor receives their payment.  The amount of earnings that can be used for payments can be limited (see attachment-exempt threshold).  The system will then divide the available earnings starting with the creditor with the highest priority.  If all available earnings are spend all other attachments will not receive payment until the time that earnings are available to meet them.
                      example: 0
                      format: int32
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                    type:
                      description: The type of creditor. A preferent creditor has priority over non-preferent creditors.
                      format: metadata
                      properties:
                        key:
                          example: 1
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: Preferente schuldeiser
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                  type: object
                description1:
                  description: |
                    Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                  example: Savings to different account
                  maxLength: 32
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                description2:
                  description: |
                    Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                  example: from net wage
                  maxLength: 32
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                descriptionPayslip:
                  description: |
                    This value is shown on the payslip to identify the attachment.
                  example: payment to creditor x
                  maxLength: 14
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                endDate:
                  description: |
                    The end date of the record
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                fixedPaymentPerPayrollPeriod:
                  description: |-
                    Set a fixed sum to be payed every payroll period.

                    __Note:__ If left empty the "available" earnings will be calculated in the payroll run by subtracting the protected earnings threshold (beslagvrijevoet) from the netwage. This method can lead to variable payments per payroll period.
                  example: 50
                  format: double
                  maximum: 99999999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,8})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                iban:
                  description: |
                    International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                  example: NL52ABNA0424968264
                  maxLength: 35
                  minLength: 1
                  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
                startDate:
                  description: |
                    Start date of this record

                    __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for splitting from net salary at that date (based on the start- and enddate).
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                totalAmount:
                  properties:
                    owed:
                      description: The total amount to be paid to the creditor
                      example: 320
                      format: double
                      maximum: 99999999.99
                      minimum: 0.01
                      nullable: false
                      pattern: ^(\d{1,8})(\.\d{1,2})?$
                      readOnly: false
                      type: number
                    paid:
                      properties:
                        inApprovedPayrollRuns:
                          description: The total amount registerd in payroll run(s) with the status "approved".
                          example: 50
                          format: double
                          maximum: 99999999.99
                          minimum: 0
                          nullable: false
                          pattern: ^(\d{1,8})(\.\d{1,2})?$
                          readOnly: true
                          type: number
                        inOpenPayrollRun:
                          description: |-
                            The total amount registerd in payroll run(s) with the status "open". 

                            Note that open payroll runs are not final until they get approved, changes are posible until then.
                          example: 0
                          format: double
                          maximum: 99999999.99
                          minimum: 0
                          nullable: false
                          pattern: ^(\d{1,8})(\.\d{1,2})?$
                          readOnly: true
                          type: number
                      readOnly: true
                      type: object
                  type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          beneficiary:
                            description: Information regarding the beneficiary coresponding with the bank account number
                            nullable: false
                            properties:
                              city:
                                description: |
                                  City name of beneficiary
                                example: Rome
                                maxLength: 24
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              name:
                                description: |
                                  Name of the beneficiary
                                example: Ben Hur
                                maxLength: 70
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                            type: object
                          creditor:
                            description: Information regarding the creditor
                            nullable: false
                            properties:
                              priority:
                                description: The priority of a creditor within the type of creditors. 0 is the highest priority followed by 1 etc. Priority dictates the order in which creditor receives their payment.  The amount of earnings that can be used for payments can be limited (see attachment-exempt threshold).  The system will then divide the available earnings starting with the creditor with the highest priority.  If all available earnings are spend all other attachments will not receive payment until the time that earnings are available to meet them.
                                example: 0
                                format: int32
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                              type:
                                description: The type of creditor. A preferent creditor has priority over non-preferent creditors.
                                format: metadata
                                properties:
                                  key:
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Preferente schuldeiser
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                            type: object
                          description1:
                            description: |
                              Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: Savings to different account
                            maxLength: 32
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          description2:
                            description: |
                              Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: from net wage
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          descriptionPayslip:
                            description: |
                              This value is shown on the payslip to identify the attachment.
                            example: payment to creditor x
                            maxLength: 14
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          endDate:
                            description: |
                              The end date of the record
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          fixedPaymentPerPayrollPeriod:
                            description: |-
                              Set a fixed sum to be payed every payroll period.

                              __Note:__ If left empty the "available" earnings will be calculated in the payroll run by subtracting the protected earnings threshold (beslagvrijevoet) from the netwage. This method can lead to variable payments per payroll period.
                            example: 50
                            format: double
                            maximum: 99999999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,8})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          iban:
                            description: |
                              International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                            example: NL52ABNA0424968264
                            maxLength: 35
                            minLength: 1
                            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
                          startDate:
                            description: |
                              Start date of this record

                              __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for splitting from net salary at that date (based on the start- and enddate).
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          totalAmount:
                            properties:
                              owed:
                                description: The total amount to be paid to the creditor
                                example: 320
                                format: double
                                maximum: 99999999.99
                                minimum: 0.01
                                nullable: false
                                pattern: ^(\d{1,8})(\.\d{1,2})?$
                                readOnly: false
                                type: number
                              paid:
                                properties:
                                  inApprovedPayrollRuns:
                                    description: The total amount registerd in payroll run(s) with the status "approved".
                                    example: 50
                                    format: double
                                    maximum: 99999999.99
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,8})(\.\d{1,2})?$
                                    readOnly: true
                                    type: number
                                  inOpenPayrollRun:
                                    description: |-
                                      The total amount registerd in payroll run(s) with the status "open". 

                                      Note that open payroll runs are not final until they get approved, changes are posible until then.
                                    example: 0
                                    format: double
                                    maximum: 99999999.99
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,8})(\.\d{1,2})?$
                                    readOnly: true
                                    type: number
                                readOnly: true
                                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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of an attachment of earnings record
      tags:
        - Attachment of earnings
  "/providers/employers/employees/employments/basesforcalculation/{baseforcalculationId}":
    delete:
      description: |
        __Activity name :__ DeleteBaseForCalculationByBaseForCalculationId

        Delete an existing base for calculation
      operationId: DeleteBaseForCalculationByBaseForCalculationId
      parameters:
        - description: The unique identifier of a base for calculation
          in: path
          name: baseforcalculationId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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:
        - Base for calculation
    get:
      description: |
        __Activity name :__ GetBaseForCalculationByBaseForCalculationId

        Get the details of a base for employment fund calculations.
      operationId: GetBaseForCalculationByBaseForCalculationId
      parameters:
        - description: The unique identifier of a base for calculation
          in: path
          name: baseforcalculationId
          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 <TOKEN>
            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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        allOf:
                          - properties:
                              ageBasedMaximum:
                                description: |
                                  This fields indicates how the age based maximum is applied
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The number for the ageBasedMaximum
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: |
                                      The description of the ageBasedMaximum
                                    example: Toepassen hoogste leeftijd
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              ageBasedMinimum:
                                description: |
                                  This fields indicates how the age based minimum is applied
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The number for the ageBasedMinimum
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: |
                                      The description of the ageBasedMinimum
                                    example: Toepassen hoogste leeftijd
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              deviations:
                                description: |-
                                  Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `base`. 
                                  Set `deviations` to null if no deviations apply.

                                  Deviating is done on either all the fields or none.
                                nullable: true
                                properties:
                                  financialReservationPercentage:
                                    description: deviation from the financial reservation percentage
                                    example: 10.000007
                                    format: double
                                    maximum: 999.999999
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,3})(\.\d{1,6})?$
                                    readOnly: false
                                    type: number
                                  percentage:
                                    description: Deviation from the percentage
                                    example: 8
                                    format: double
                                    maximum: 999.999999
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,3})(\.\d{1,6})?$
                                    readOnly: false
                                    type: number
                                  reservationPercentage:
                                    description: deviation from the reservation percentage
                                    example: 12.0007
                                    format: double
                                    maximum: 999.999999
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,3})(\.\d{1,6})?$
                                    readOnly: false
                                    type: number
                                readOnly: false
                                type: object
                              endDate:
                                description: The end date of the entity. The date is up to and including.
                                example: 2018-10-23
                                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 on which this base starts.

                                  A (linked chain)[./#section/Data/Date-chains] per base is maintained within this resource.
                                  So multiple bases can be active at the same time but one specific base can never be active multiple times at the same time.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: false
                                type: string
                          - properties:
                              base:
                                description: |
                                  `base` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The number for the base
                                    example: 545
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: |
                                      The description of the base
                                    example: VAKANTIE TOESLAG, periodieke opbouw
                                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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 base for employment fund calculations
      tags:
        - Base for calculation
    put:
      description: |
        __Activity name :__ PutBaseForCalculationByBaseForCalculationId

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.

        Edit the properties of a base for calculation
      operationId: PutBaseForCalculationByBaseForCalculationId
      parameters:
        - description: The unique identifier of a base for calculation
          in: path
          name: baseforcalculationId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              allOf:
                - properties:
                    ageBasedMaximum:
                      description: |
                        This fields indicates how the age based maximum is applied
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          description: |
                            The number for the ageBasedMaximum
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          description: |
                            The description of the ageBasedMaximum
                          example: Toepassen hoogste leeftijd
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    ageBasedMinimum:
                      description: |
                        This fields indicates how the age based minimum is applied
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          description: |
                            The number for the ageBasedMinimum
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          description: |
                            The description of the ageBasedMinimum
                          example: Toepassen hoogste leeftijd
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    deviations:
                      description: |-
                        Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `base`. 
                        Set `deviations` to null if no deviations apply.

                        Deviating is done on either all the fields or none.
                      nullable: true
                      properties:
                        financialReservationPercentage:
                          description: deviation from the financial reservation percentage
                          example: 10.000007
                          format: double
                          maximum: 999.999999
                          minimum: 0
                          nullable: false
                          pattern: ^(\d{1,3})(\.\d{1,6})?$
                          readOnly: false
                          type: number
                        percentage:
                          description: Deviation from the percentage
                          example: 8
                          format: double
                          maximum: 999.999999
                          minimum: 0
                          nullable: false
                          pattern: ^(\d{1,3})(\.\d{1,6})?$
                          readOnly: false
                          type: number
                        reservationPercentage:
                          description: deviation from the reservation percentage
                          example: 12.0007
                          format: double
                          maximum: 999.999999
                          minimum: 0
                          nullable: false
                          pattern: ^(\d{1,3})(\.\d{1,6})?$
                          readOnly: false
                          type: number
                      readOnly: false
                      type: object
                    endDate:
                      description: The end date of the entity. The date is up to and including.
                      example: 2018-10-23
                      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 on which this base starts.

                        A (linked chain)[./#section/Data/Date-chains] per base is maintained within this resource.
                        So multiple bases can be active at the same time but one specific base can never be active multiple times at the same time.
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: false
                      type: string
        description: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        allOf:
                          - properties:
                              ageBasedMaximum:
                                description: |
                                  This fields indicates how the age based maximum is applied
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The number for the ageBasedMaximum
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: |
                                      The description of the ageBasedMaximum
                                    example: Toepassen hoogste leeftijd
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              ageBasedMinimum:
                                description: |
                                  This fields indicates how the age based minimum is applied
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The number for the ageBasedMinimum
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: |
                                      The description of the ageBasedMinimum
                                    example: Toepassen hoogste leeftijd
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              deviations:
                                description: |-
                                  Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `base`. 
                                  Set `deviations` to null if no deviations apply.

                                  Deviating is done on either all the fields or none.
                                nullable: true
                                properties:
                                  financialReservationPercentage:
                                    description: deviation from the financial reservation percentage
                                    example: 10.000007
                                    format: double
                                    maximum: 999.999999
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,3})(\.\d{1,6})?$
                                    readOnly: false
                                    type: number
                                  percentage:
                                    description: Deviation from the percentage
                                    example: 8
                                    format: double
                                    maximum: 999.999999
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,3})(\.\d{1,6})?$
                                    readOnly: false
                                    type: number
                                  reservationPercentage:
                                    description: deviation from the reservation percentage
                                    example: 12.0007
                                    format: double
                                    maximum: 999.999999
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,3})(\.\d{1,6})?$
                                    readOnly: false
                                    type: number
                                readOnly: false
                                type: object
                              endDate:
                                description: The end date of the entity. The date is up to and including.
                                example: 2018-10-23
                                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 on which this base starts.

                                  A (linked chain)[./#section/Data/Date-chains] per base is maintained within this resource.
                                  So multiple bases can be active at the same time but one specific base can never be active multiple times at the same time.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: false
                                type: string
                          - properties:
                              base:
                                description: |
                                  `base` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The number for the base
                                    example: 545
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: |
                                      The description of the base
                                    example: VAKANTIE TOESLAG, periodieke opbouw
                                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Change the properties of a base for calculation
      tags:
        - Base for calculation
  "/providers/employers/employees/employments/basesforemploymentfundcalculation/{baseforemploymentfundcalculationId}":
    delete:
      description: |
        __Activity name :__ DeleteBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId

        Delete an existing base for employment fund calculation
      operationId: DeleteBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId
      parameters:
        - description: The unique identifier of a base for employment fund calculation
          in: path
          name: baseforemploymentfundcalculationId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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:
        - Base for employment fund calculation
    get:
      description: |
        __Activity name :__ GetBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId

        Get the details of a base for employment fund calculations.
      operationId: GetBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId
      parameters:
        - description: The unique identifier of a base for employment fund calculation
          in: path
          name: baseforemploymentfundcalculationId
          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 <TOKEN>
            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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        allOf:
                          - properties:
                              base:
                                description: |
                                  The base (amount of money) to be used in the fund calculation
                                example: 25000
                                format: double
                                maximum: 999999.99
                                minimum: 0.01
                                nullable: false
                                pattern: ^(\d{1,6})(\.\d{1,2})?$
                                readOnly: false
                                type: number
                              endDate:
                                description: The end date of the entity. The date is up to and including.
                                example: 2018-10-23
                                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
                              origin:
                                description: |
                                  Indicates the method by which the record was created/changed, its origin. The origin influences certain business processes. For example if a record exists with origin manually entered (Normale wijziging) the process that calculates the base automatically will not do so as a manually entered value allready exists.
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The number for the origin
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  value:
                                    description: |
                                      The description of the origin
                                    example: Normale wijziging
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              startDate:
                                description: |-
                                  The date on which this base for calculation starts.

                                  A (linked chain)[./#section/Data/Date-chains] per base for calculation is maintained within this resource. So multiple bases can be active at the same time for different payrollcomponents
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: false
                                type: string
                          - properties:
                              payrollComponent:
                                description: |
                                  A payroll component is the link to the salary calculation. In this case only specific payrollcomponents are available. The payroll components that are reserved for use as the base for fund calculations

                                  `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                format: metadata
                                nullable: false
                                properties:
                                  description:
                                    description: |
                                      The description of the payroll component
                                    example: JAAR GRSL3
                                    maxLength: 14
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  key:
                                    description: |
                                      The number for the payroll component.                      
                                    example: 545
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                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: 2018-12-31
                            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 <field>
                              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.
                                See [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 base for employment fund calculations
      tags:
        - Base for employment fund calculation
    put:
      description: |
        __Activity name :__ PutBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId

        __Metadata :__ Possible options for fields of the type "metadata" can be acquired (GET) by adding `/metadata` to the PUT URL.

        Edit the properties of a base for employment calculation
      operationId: PutBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId
      parameters:
        - description: The unique identifier of a base for employment fund calculation
          in: path
          name: baseforemploymentfundcalculationId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              allOf:
                - properties:
                    base:
                      description: |
                        The base (amount of money) to be used in the fund calculation
                      example: 25000
                      format: double
                      maximum: 999999.99
                      minimum: 0.01
                      nullable: false
                      pattern: ^(\d{1,6})(\.\d{1,2})?$
                      readOnly: false
                      type: number
                    endDate:
                      description: The end date of the entity. The date is up to and including.
                      example: 2018-10-23
                      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
                    origin:
                      description: |
                        Indicates the method by which the record was created/changed, its origin. The origin influences certain business processes. For example if a record exists with origin manually entered (Normale wijziging) the process that calculates the base automatically will not do so as a manually entered value allready exists.
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          description: |
                            The number for the origin
                          example: 1
                          format: int32
                          nullable: false
                          readOnly: true
                          type: integer
                        value:
                          description: |
                            The description of the origin
                          example: Normale wijziging
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    startDate:
                      description: |-
                        The date on which this base for calculation starts.

                        A (linked chain)[./#section/Data/Date-chains] per base for calculation is maintained within this resource. So multiple bases can be active at the same time for different payrollcomponents
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: false
                      type: string
        description: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        allOf:
                          - properties:
                              base:
                                description: |
                                  The base (amount of money) to be used in the fund calculation
                                example: 25000
                                format: double
                                maximum: 999999.99
                                minimum: 0.01
                                nullable: false
                                pattern: ^(\d{1,6})(\.\d{1,2})?$
                                readOnly: false
                                type: number
                              endDate:
                                description: The end date of the entity. The date is up to and including.
                                example: 2018-10-23
                                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
                              origin:
                                description: |
                                  Indicates the method by which the record was created/changed, its origin. The origin influences certain business processes. For example if a record exists with origin manually entered (Normale wijziging) the process that calculates the base automatically will not do so as a manually entered value allready exists.
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The number for the origin
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  value:
                                    description: |
                                      The description of the origin
                                    example: Normale wijziging
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              startDate:
                                description: |-
                                  The date on which this base for calculation starts.

                                  A (linked chain)[./#section/Data/Date-chains] per base for calculation is maintained within this resource. So multiple bases can be active at the same time for different payrollcomponents
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: false
                                type: string
                          - properties:
                              payrollComponent:
                                description: |
                                  A payroll component is the link to the salary calculation. In this case only specific payrollcomponents are available. The payroll components that are reserved for use as the base for fund calculations

                                  `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                format: metadata
                                nullable: false
                                properties:
                                  description:
                                    description: |
                                      The description of the payroll component
                                    example: JAAR GRSL3
                                    maxLength: 14
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  key:
                                    description: |
                                      The number for the payroll component.                      
                                    example: 545
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Change the properties of a base for employment fund calculation
      tags:
        - Base for employment fund calculation
  "/providers/employers/employees/employments/benefitsAndDeductions/{benefitsanddeductionsId}":
    delete:
      description: |
        __Activity name :__ DeleteBenefitsAndDeductionsByBenefitsAndDeductionsId

        Delete a benefit or deduction for the employment
      operationId: DeleteBenefitsAndDeductionsByBenefitsAndDeductionsId
      parameters:
        - description: The unique identifier of the benefits and deductions data
          in: path
          name: benefitsanddeductionsId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 benefit or deduction record
      tags:
        - Benefits and deductions
    get:
      description: |
        __Activity name :__ GetBenefitsAndDeductionsBybenefitsAndDeductionsId

        Get a benefit or deduction for the employment
      operationId: GetBenefitsAndDeductionsBybenefitsAndDeductionsId
      parameters:
        - description: The unique identifier of the benefits and deductions data
          in: path
          name: benefitsanddeductionsId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          endDate:
                            description: |
                              The end date for the information in the record.
                            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
                          payrollComponent:
                            description: |
                              A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                              `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              category:
                                description: |
                                  The category of the payroll component. There are six viable categories for this resource: <br/> 7,  Bruto vergoeding volgens tabel<br/> 9,  Netto vergoeding<br/> 30, Bedrag per eenheid<br/> 12, Bruto inhouding<br/> 13, Netto inhouding<br/> 11, Fiscale bijtelling <br/> 17, Afdrachtvermindering<br/>
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  value:
                                    example: Uren
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              deductionOrPayment:
                                description: |
                                  Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  value:
                                    example: Betaling
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              description:
                                description: |
                                  The description of the payroll component
                                example: Uren gewerkt
                                maxLength: 14
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                description: |
                                  The number for the payroll component.
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            readOnly: true
                            type: object
                          startDate:
                            description: |
                              The start date for the information in the record.

                              A (linked chain)[./#section/Data/Date-chains] per payroll component is maintained within this resource.
                            example: 1995-05-21
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          value:
                            description: |
                              The value for the selected payroll component.    <br/>
                            example: 50.87
                            maximum: 99999.99
                            minimum: 0.01
                            nullable: false
                            readOnly: false
                            type: number
                    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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Detail of a benefit or deduction record
      tags:
        - Benefits and deductions
    put:
      description: |
        __Activity name :__ PutBenefitsAndDeductionsByBenefitsAndDeductionsId

        Update a benefit or deduction for the employment
        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.
      operationId: PutBenefitsAndDeductionsByBenefitsAndDeductionsId
      parameters:
        - description: The unique identifier of the benefits and deductions data
          in: path
          name: benefitsanddeductionsId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                endDate:
                  description: |
                    The end date for the information in the record.
                  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
                payrollComponent:
                  description: |
                    A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                    `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    category:
                      description: |
                        The category of the payroll component. There are six viable categories for this resource: <br/> 7,  Bruto vergoeding volgens tabel<br/> 9,  Netto vergoeding<br/> 30, Bedrag per eenheid<br/> 12, Bruto inhouding<br/> 13, Netto inhouding<br/> 11, Fiscale bijtelling <br/> 17, Afdrachtvermindering<br/>
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          example: 1
                          format: int32
                          nullable: false
                          readOnly: true
                          type: integer
                        value:
                          example: Uren
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    deductionOrPayment:
                      description: |
                        Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: true
                          type: integer
                        value:
                          example: Betaling
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    description:
                      description: |
                        The description of the payroll component
                      example: Uren gewerkt
                      maxLength: 14
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      description: |
                        The number for the payroll component.
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  readOnly: true
                  type: object
                startDate:
                  description: |
                    The start date for the information in the record.

                    A (linked chain)[./#section/Data/Date-chains] per payroll component is maintained within this resource.
                  example: 1995-05-21
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                value:
                  description: |
                    The value for the selected payroll component.    <br/>
                  example: 50.87
                  maximum: 99999.99
                  minimum: 0.01
                  nullable: false
                  readOnly: false
                  type: number
        description: data 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          endDate:
                            description: |
                              The end date for the information in the record.
                            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
                          payrollComponent:
                            description: |
                              A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                              `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              category:
                                description: |
                                  The category of the payroll component. There are six viable categories for this resource: <br/> 7,  Bruto vergoeding volgens tabel<br/> 9,  Netto vergoeding<br/> 30, Bedrag per eenheid<br/> 12, Bruto inhouding<br/> 13, Netto inhouding<br/> 11, Fiscale bijtelling <br/> 17, Afdrachtvermindering<br/>
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  value:
                                    example: Uren
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              deductionOrPayment:
                                description: |
                                  Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  value:
                                    example: Betaling
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              description:
                                description: |
                                  The description of the payroll component
                                example: Uren gewerkt
                                maxLength: 14
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                description: |
                                  The number for the payroll component.
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            readOnly: true
                            type: object
                          startDate:
                            description: |
                              The start date for the information in the record.

                              A (linked chain)[./#section/Data/Date-chains] per payroll component is maintained within this resource.
                            example: 1995-05-21
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          value:
                            description: |
                              The value for the selected payroll component.    <br/>
                            example: 50.87
                            maximum: 99999.99
                            minimum: 0.01
                            nullable: false
                            readOnly: false
                            type: number
                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a benefit or deduction record
      tags:
        - Benefits and deductions
  "/providers/employers/employees/employments/benefitsinkind/{benefitInKindId}":
    delete:
      description: |
        __Activity name :__ DeleteBenefitInKindByBenefitInKindId

        Delete an existing benefit in kind record
      operationId: DeleteBenefitInKindByBenefitInKindId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: benefitInKindId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 benefit in kind record
      tags:
        - Benefit in kind
    get:
      description: |
        __Activity name :__ GetBenefitInKindByBenefitInKindId

        Get the details of a benefit in kind
      operationId: GetBenefitInKindByBenefitInKindId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: benefitInKindId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            benefitInKindType:
                              description: The benefit in kind of the employment. `benefitinkind` is a metadata field within the employer context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                description:
                                  example: Mobiele telefoon
                                  nullable: false
                                  readOnly: true
                                  type: string
                                id:
                                  description: |
                                    The unique identifier of an object (GUID/UUID)
                                  example: 36530F13-59EB-4C15-B5F2-4F92B070A208
                                  format: uuid
                                  nullable: false
                                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                  readOnly: false
                                  type: string
                              type: object
                            brand:
                              description: The brand of the benefit in kind.
                              example: Apple
                              maxLength: 30
                              nullable: true
                              readOnly: false
                              type: string
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              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
                            particularities:
                              description: Extra information about the benefit in kind
                              example: geen bijzonderheden
                              maxLength: 4000
                              nullable: true
                              readOnly: false
                              type: string
                            startDate:
                              description: |
                                The date on which this BenefitInKind starts.

                                So multiple Benefits in kind can be active at the same time but one specific BenefitsInKind can never be active multiple times at the same time.
                              example: 2018-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            supplier:
                              description: The supplier of the benefit in kind.
                              example: Mediamarkt
                              maxLength: 30
                              nullable: true
                              readOnly: false
                              type: string
                            type:
                              description: The type of the benefit in kind.
                              example: Iphone 11
                              maxLength: 30
                              nullable: true
                              readOnly: false
                              type: string
                            value:
                              description: The value for the selected benefit of kind.
                              example: 1100
                              minimum: 0
                              nullable: false
                              pattern: ^(\d{1,5})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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
      tags:
        - Benefit in kind
    put:
      description: |
        __Activity name :__ PutBenefitInKindByBenefitInKindId

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.
      operationId: PutBenefitInKindByBenefitInKindId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: benefitInKindId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                benefitInKindType:
                  description: The benefit in kind of the employment. `benefitinkind` is a metadata field within the employer context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    description:
                      example: Mobiele telefoon
                      nullable: false
                      readOnly: true
                      type: string
                    id:
                      description: |
                        The unique identifier of an object (GUID/UUID)
                      example: 36530F13-59EB-4C15-B5F2-4F92B070A208
                      format: uuid
                      nullable: false
                      pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                      readOnly: false
                      type: string
                  type: object
                brand:
                  description: The brand of the benefit in kind.
                  example: Apple
                  maxLength: 30
                  nullable: true
                  readOnly: false
                  type: string
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  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
                particularities:
                  description: Extra information about the benefit in kind
                  example: geen bijzonderheden
                  maxLength: 4000
                  nullable: true
                  readOnly: false
                  type: string
                startDate:
                  description: |
                    The date on which this BenefitInKind starts.

                    So multiple Benefits in kind can be active at the same time but one specific BenefitsInKind can never be active multiple times at the same time.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                supplier:
                  description: The supplier of the benefit in kind.
                  example: Mediamarkt
                  maxLength: 30
                  nullable: true
                  readOnly: false
                  type: string
                type:
                  description: The type of the benefit in kind.
                  example: Iphone 11
                  maxLength: 30
                  nullable: true
                  readOnly: false
                  type: string
                value:
                  description: The value for the selected benefit of kind.
                  example: 1100
                  minimum: 0
                  nullable: false
                  pattern: ^(\d{1,5})(\.\d{1,2})?$
                  readOnly: false
                  type: number
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          benefitInKindType:
                            description: The benefit in kind of the employment. `benefitinkind` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Mobiele telefoon
                                nullable: false
                                readOnly: true
                                type: string
                              id:
                                description: |
                                  The unique identifier of an object (GUID/UUID)
                                example: 36530F13-59EB-4C15-B5F2-4F92B070A208
                                format: uuid
                                nullable: false
                                pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                readOnly: false
                                type: string
                            type: object
                          brand:
                            description: The brand of the benefit in kind.
                            example: Apple
                            maxLength: 30
                            nullable: true
                            readOnly: false
                            type: string
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            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
                          particularities:
                            description: Extra information about the benefit in kind
                            example: geen bijzonderheden
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          startDate:
                            description: |
                              The date on which this BenefitInKind starts.

                              So multiple Benefits in kind can be active at the same time but one specific BenefitsInKind can never be active multiple times at the same time.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          supplier:
                            description: The supplier of the benefit in kind.
                            example: Mediamarkt
                            maxLength: 30
                            nullable: true
                            readOnly: false
                            type: string
                          type:
                            description: The type of the benefit in kind.
                            example: Iphone 11
                            maxLength: 30
                            nullable: true
                            readOnly: false
                            type: string
                          value:
                            description: The value for the selected benefit of kind.
                            example: 1100
                            minimum: 0
                            nullable: false
                            pattern: ^(\d{1,5})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit a benefit in kind record
      tags:
        - Benefit in kind
  "/providers/employers/employees/employments/companycars/{companyCarId}":
    delete:
      description: |
        __Activity name:__ DeleteCompanyCarByCompanyCarId

        Delete a company car record for the employment

        Please note this resource is related for the registration of the company car for HRM purposes. This resource is NOT related to the registration of the fiscal company car(s) which is used in salary calculations.
      operationId: DeleteCompanyCarByCompanyCarId
      parameters:
        - description: The unique identifier of the company car
          in: path
          name: companyCarId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 company car record
      tags:
        - Company car
    get:
      description: |
        __Activity name:__ GetCompanyCarByCompanyCarId


         Get the details of a company car 


        Please note this resource is related for the registration of the company car for HRM purposes. This resource is NOT related to the registration of the fiscal company car(s) which is used in salary calculations.
      operationId: GetCompanyCarByCompanyCarId
      parameters:
        - description: The unique identifier of the company car
          in: path
          name: companyCarId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          brand:
                            description: |
                              Brand of the vehicle.
                            example: Volvo
                            maximum: 25
                            nullable: true
                            readOnly: false
                            type: string
                          catalogValue:
                            description: |
                              The catalog value of the car.
                            example: 20000
                            format: double
                            maximum: 999999.99
                            nullable: true
                            pattern: ^(\d{1,6})(.\d{1,2})?$
                            readOnly: false
                            type: number
                          comments:
                            description: |
                              Any comments on the car or the contract.
                            example: This car is very nice
                            maximum: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2023-10-23
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          fuelCardNumber:
                            description: |
                              Registration number of the fuel card.
                            example: B100.323.903
                            maximum: 20
                            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
                          kilometersPrivateUse:
                            description: |
                              The number kilometers per year the employee can use the car for private purposes.
                            example: 10000
                            format: int32
                            nullable: true
                            readOnly: false
                            type: integer
                          lease:
                            description: |
                              Details of the leasecontract
                            nullable: true
                            properties:
                              contractNumber:
                                description: |
                                  Registration number of the lease contract.
                                example: 2021.323.903
                                maximum: 20
                                nullable: true
                                readOnly: false
                                type: string
                              endDate:
                                description: The end date of the entity. The date is up to and including.
                                example: 2023-10-23
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              startDate:
                                description: The start date of the entity.
                                example: 2021-01-01
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                            type: object
                          leaseOrBuy:
                            description: |
                              Indication of the ownership of the company car.
                            format: metaData
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Koop
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          licensePlateNumber:
                            description: |
                              Vehicle registration number (license plate) of the  company car. The number should be provided with or without any hyphens (-).
                            example: GP586D
                            maxLength: 8
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          model:
                            description: |
                              Model of the vehicle.
                            example: V60
                            maximum: 25
                            nullable: true
                            readOnly: false
                            type: string
                          startDate:
                            description: The start date of the entity.
                            example: 2021-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          supplier:
                            description: |
                              Name of the company the delivered the company car.
                            example: Leasemaatschappij Tilburg
                            maximum: 30
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 company car record
      tags:
        - Company car
    put:
      description: |
        __Activity name:__ PutCompanyCarByCompanyCarId


         Edit the details for a company car record.


        Please note this resource is related for the registration of the company car for HRM purposes. This resource is NOT related to the registration of the fiscal company car(s) which is used in salary calculations.


         __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.
      operationId: PutCompanyCarByCompanyCarId
      parameters:
        - description: The unique identifier of the company car
          in: path
          name: companyCarId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              nullable: true
              properties:
                brand:
                  description: |
                    Brand of the vehicle.
                  example: Volvo
                  maximum: 25
                  nullable: true
                  readOnly: false
                  type: string
                catalogValue:
                  description: |
                    The catalog value of the car.
                  example: 20000
                  format: double
                  maximum: 999999.99
                  nullable: true
                  pattern: ^(\d{1,6})(.\d{1,2})?$
                  readOnly: false
                  type: number
                comments:
                  description: |
                    Any comments on the car or the contract.
                  example: This car is very nice
                  maximum: 4000
                  nullable: true
                  readOnly: false
                  type: string
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2023-10-23
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                fuelCardNumber:
                  description: |
                    Registration number of the fuel card.
                  example: B100.323.903
                  maximum: 20
                  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
                kilometersPrivateUse:
                  description: |
                    The number kilometers per year the employee can use the car for private purposes.
                  example: 10000
                  format: int32
                  nullable: true
                  readOnly: false
                  type: integer
                lease:
                  description: |
                    Details of the leasecontract
                  nullable: true
                  properties:
                    contractNumber:
                      description: |
                        Registration number of the lease contract.
                      example: 2021.323.903
                      maximum: 20
                      nullable: true
                      readOnly: false
                      type: string
                    endDate:
                      description: The end date of the entity. The date is up to and including.
                      example: 2023-10-23
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    startDate:
                      description: The start date of the entity.
                      example: 2021-01-01
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                  type: object
                leaseOrBuy:
                  description: |
                    Indication of the ownership of the company car.
                  format: metaData
                  nullable: false
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Koop
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                licensePlateNumber:
                  description: |
                    Vehicle registration number (license plate) of the  company car. The number should be provided with or without any hyphens (-).
                  example: GP586D
                  maxLength: 8
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                model:
                  description: |
                    Model of the vehicle.
                  example: V60
                  maximum: 25
                  nullable: true
                  readOnly: false
                  type: string
                startDate:
                  description: The start date of the entity.
                  example: 2021-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                supplier:
                  description: |
                    Name of the company the delivered the company car.
                  example: Leasemaatschappij Tilburg
                  maximum: 30
                  nullable: true
                  readOnly: false
                  type: string
              type: object
        description: Company Car 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          brand:
                            description: |
                              Brand of the vehicle.
                            example: Volvo
                            maximum: 25
                            nullable: true
                            readOnly: false
                            type: string
                          catalogValue:
                            description: |
                              The catalog value of the car.
                            example: 20000
                            format: double
                            maximum: 999999.99
                            nullable: true
                            pattern: ^(\d{1,6})(.\d{1,2})?$
                            readOnly: false
                            type: number
                          comments:
                            description: |
                              Any comments on the car or the contract.
                            example: This car is very nice
                            maximum: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2023-10-23
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          fuelCardNumber:
                            description: |
                              Registration number of the fuel card.
                            example: B100.323.903
                            maximum: 20
                            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
                          kilometersPrivateUse:
                            description: |
                              The number kilometers per year the employee can use the car for private purposes.
                            example: 10000
                            format: int32
                            nullable: true
                            readOnly: false
                            type: integer
                          lease:
                            description: |
                              Details of the leasecontract
                            nullable: true
                            properties:
                              contractNumber:
                                description: |
                                  Registration number of the lease contract.
                                example: 2021.323.903
                                maximum: 20
                                nullable: true
                                readOnly: false
                                type: string
                              endDate:
                                description: The end date of the entity. The date is up to and including.
                                example: 2023-10-23
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              startDate:
                                description: The start date of the entity.
                                example: 2021-01-01
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                            type: object
                          leaseOrBuy:
                            description: |
                              Indication of the ownership of the company car.
                            format: metaData
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Koop
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          licensePlateNumber:
                            description: |
                              Vehicle registration number (license plate) of the  company car. The number should be provided with or without any hyphens (-).
                            example: GP586D
                            maxLength: 8
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          model:
                            description: |
                              Model of the vehicle.
                            example: V60
                            maximum: 25
                            nullable: true
                            readOnly: false
                            type: string
                          startDate:
                            description: The start date of the entity.
                            example: 2021-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          supplier:
                            description: |
                              Name of the company the delivered the company car.
                            example: Leasemaatschappij Tilburg
                            maximum: 30
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a company car record
      tags:
        - Company car
  "/providers/employers/employees/employments/costperhour/{costperhourId}":
    delete:
      description: |
        __Activity name :__ DeleteCostPerHourByCostPerHourId

        Delete an existing cost per hour record
      operationId: DeleteCostPerHourByCostPerHourId
      parameters:
        - description: The unique identifier of the record
          in: query
          name: costPerHourId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
        - description: Automatically added
          in: path
          name: costperhourId
          required: true
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 cost per hour record
      tags:
        - Cost per hour
    get:
      description: |
        __Activity name :__ GetCostPerHourByCostPerHourId

        Get the details of a cost per hour record
      operationId: GetCostPerHourByCostPerHourId
      parameters:
        - description: The unique identifier of the record
          in: query
          name: costPerHourId
          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 <TOKEN>
            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: costperhourId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: false
                          properties:
                            costPerHour:
                              description: |
                                The cost per hour for the employment
                              example: 21.2
                              format: double
                              maximum: 99999.99
                              minimum: -99999.99
                              nullable: false
                              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
                            payrollPeriods:
                              description: The period of the kpu record.
                              properties:
                                endDate:
                                  description: The last day of the payroll period
                                  example: 2020-01-31
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                id:
                                  description: The id for this specific payroll period.
                                  example: 202001
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                periodNumber:
                                  description: The period number of the payroll period
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                startDate:
                                  description: The first day of the payroll period
                                  example: 2020-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                year:
                                  description: The payroll year
                                  example: 2020
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              type: object
                            registrationMethod:
                              description: This object indicates how the cost per hour was aquired. Possible values are Verloning, Schatting and Handmatig
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: "The key of the registrationmethod ('Wijze van aanmaken'). "
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  description: The description of registrationmethod ('Wijze van aanmaken'). Possible values are "Verloning", "Schatting" and "Handmatig"
                                  example: Verloning
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 cost per hour
      tags:
        - Cost per hour
    put:
      description: |
        __Activity name :__ PutCostperhourByCostperhourId

        __Metadata :__ No metadata.
      operationId: PutCostperhourByCostperhourId
      parameters:
        - description: The unique identifier of the record
          in: query
          name: costPerHourId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
        - description: Automatically added
          in: path
          name: costperhourId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              nullable: false
              properties:
                costPerHour:
                  description: |
                    The cost per hour for the employment
                  example: 21.2
                  format: double
                  maximum: 99999.99
                  minimum: -99999.99
                  nullable: false
                  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
                payrollPeriods:
                  description: The period of the kpu record.
                  nullable: false
                  properties:
                    endDate:
                      description: The last day of the payroll period
                      example: 2020-01-31
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    id:
                      description: The id for this specific payroll period.
                      example: 202001
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    periodNumber:
                      description: The period number of the payroll period
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    startDate:
                      description: The first day of the payroll period
                      example: 2020-01-01
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    year:
                      description: The payroll year
                      example: 2020
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                  readOnly: true
                  type: object
                registrationMethod:
                  description: This object indicates how the cost per hour was aquired. Possible values are Verloning, Schatting and Handmatig
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      description: "The key of the registrationmethod ('Wijze van aanmaken'). "
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    value:
                      description: The description of registrationmethod ('Wijze van aanmaken'). Possible values are "Verloning", "Schatting" and "Handmatig"
                      example: Verloning
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
              type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          costPerHour:
                            description: |
                              The cost per hour for the employment
                            example: 21.2
                            format: double
                            maximum: 99999.99
                            minimum: -99999.99
                            nullable: false
                            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
                          payrollPeriods:
                            description: The period of the kpu record.
                            properties:
                              endDate:
                                description: The last day of the payroll period
                                example: 2020-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              id:
                                description: The id for this specific payroll period.
                                example: 202001
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              periodNumber:
                                description: The period number of the payroll period
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              startDate:
                                description: The first day of the payroll period
                                example: 2020-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: The payroll year
                                example: 2020
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                            type: object
                          registrationMethod:
                            description: This object indicates how the cost per hour was aquired. Possible values are Verloning, Schatting and Handmatig
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: "The key of the registrationmethod ('Wijze van aanmaken'). "
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                description: The description of registrationmethod ('Wijze van aanmaken'). Possible values are "Verloning", "Schatting" and "Handmatig"
                                example: Verloning
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit a cost per hour record
      tags:
        - Cost per hour
  "/providers/employers/employees/employments/customfields/{employmentCustomFieldId}":
    delete:
      description: |
        __Activity name :__ DeleteEmploymentCustomFieldByEmploymentCustomFieldId

        Delete an existing custom field record
      operationId: DeleteEmploymentCustomFieldByEmploymentCustomFieldId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: employmentCustomFieldId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employment custom field record
      tags:
        - Employment custom field
    get:
      description: |
        __Activity name :__ GetEmploymentCustomFieldByEmploymentCustomFieldId

        Get the details of a custom field
      operationId: GetEmploymentCustomFieldByEmploymentCustomFieldId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: employmentCustomFieldId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            customField:
                              description: |
                                The custom field as defined at the employer-level.  The value can only be set in the POST (it cannot be changed with a PUT).
                              format: metadata
                              nullable: false
                              properties:
                                description:
                                  example: Shoe size
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                                id:
                                  description: The unique identifier of the custom field as defined at the employer level
                                  example: 025ce09b-bff2-4b05-bcf0-711a89da7c08
                                  format: uuid
                                  nullable: false
                                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                  readOnly: false
                                  type: string
                              readOnly: true
                              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
                            value:
                              description: The value for the custom field for the employment
                              example: "41"
                              maxLength: 255
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employment custom field
      tags:
        - Employment custom field
    put:
      description: |
        __Activity name :__ PutEmploymentCustomFieldByEmploymentCustomFieldId

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.
      operationId: PutEmploymentCustomFieldByEmploymentCustomFieldId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: employmentCustomFieldId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                customField:
                  description: |
                    The custom field as defined at the employer-level.  The value can only be set in the POST (it cannot be changed with a PUT).
                  format: metadata
                  nullable: false
                  properties:
                    description:
                      example: Shoe size
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                    id:
                      description: The unique identifier of the custom field as defined at the employer level
                      example: 025ce09b-bff2-4b05-bcf0-711a89da7c08
                      format: uuid
                      nullable: false
                      pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                      readOnly: false
                      type: string
                  readOnly: true
                  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
                value:
                  description: The value for the custom field for the employment
                  example: "41"
                  maxLength: 255
                  nullable: false
                  readOnly: false
                  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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          customField:
                            description: |
                              The custom field as defined at the employer-level.  The value can only be set in the POST (it cannot be changed with a PUT).
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Shoe size
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                              id:
                                description: The unique identifier of the custom field as defined at the employer level
                                example: 025ce09b-bff2-4b05-bcf0-711a89da7c08
                                format: uuid
                                nullable: false
                                pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                readOnly: false
                                type: string
                            readOnly: true
                            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
                          value:
                            description: The value for the custom field for the employment
                            example: "41"
                            maxLength: 255
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit an employment custom field record
      tags:
        - Employment custom field
  "/providers/employers/employees/employments/customnotifications/{customNotificationId}":
    delete:
      description: |
        __Activity name :__ DeleteCustomNotificationByCustomNotificationId

        Delete an existing custom notification record
      operationId: DeleteCustomNotificationByCustomNotificationId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: customNotificationId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 notification record
      tags:
        - Custom notification
    get:
      description: |
        __Activity name :__ GetCustomNotificationByCustomNotificationId

        Get the details of a custom notification
      operationId: GetCustomNotificationByCustomNotificationId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: customNotificationId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            expirationDate:
                              description: The date on which the Notification will expire.
                              example: 2021-01-23
                              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
                            notificationDate:
                              description: The date on which the first notification occurs.
                              example: 2021-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            notificationText:
                              description: The description of the signal
                              example: Signal renew document
                              nullable: false
                              readOnly: false
                              type: string
                            recurrencePattern:
                              description: |
                                Define a pattern for repeating the notification. This pattern is used to create Notifications after the initial notification as defined in the notificationDate.
                              format: metadata
                              nullable: true
                              properties:
                                numberOfRepetitionsAfterFirstNotification:
                                  description: |
                                    The number of times the notification will be repeated after the first Notification. Setting the value 99 will result in repeating the notification indefinite.
                                  example: 4
                                  format: int32
                                  maximum: 99
                                  minimum: 1
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                recurrenceNumber:
                                  description: |
                                    The number of the recurrence pattern. An example recurrence pattern is: repeat every 2 weeks.
                                  example: 2
                                  format: int32
                                  maximum: 365
                                  minimum: 1
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                recurrencePeriod:
                                  description: |
                                    The period of the recurrence pattern An example recurrence pattern is: repeat every 2 weeks.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Weeks
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 notification
      tags:
        - Custom notification
    put:
      description: |
        __Activity name :__ PutCustomNotificationByCustomNotificationId

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.
      operationId: PutCustomNotificationByCustomNotificationId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: customNotificationId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                expirationDate:
                  description: The date on which the Notification will expire.
                  example: 2021-01-23
                  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
                notificationDate:
                  description: The date on which the first notification occurs.
                  example: 2021-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                notificationText:
                  description: The description of the signal
                  example: Signal renew document
                  nullable: false
                  readOnly: false
                  type: string
                recurrencePattern:
                  description: |
                    Define a pattern for repeating the notification. This pattern is used to create Notifications after the initial notification as defined in the notificationDate.
                  format: metadata
                  nullable: true
                  properties:
                    numberOfRepetitionsAfterFirstNotification:
                      description: |
                        The number of times the notification will be repeated after the first Notification. Setting the value 99 will result in repeating the notification indefinite.
                      example: 4
                      format: int32
                      maximum: 99
                      minimum: 1
                      nullable: false
                      readOnly: false
                      type: integer
                    recurrenceNumber:
                      description: |
                        The number of the recurrence pattern. An example recurrence pattern is: repeat every 2 weeks.
                      example: 2
                      format: int32
                      maximum: 365
                      minimum: 1
                      nullable: false
                      readOnly: false
                      type: integer
                    recurrencePeriod:
                      description: |
                        The period of the recurrence pattern An example recurrence pattern is: repeat every 2 weeks.
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: Weeks
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                  type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          expirationDate:
                            description: The date on which the Notification will expire.
                            example: 2021-01-23
                            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
                          notificationDate:
                            description: The date on which the first notification occurs.
                            example: 2021-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          notificationText:
                            description: The description of the signal
                            example: Signal renew document
                            nullable: false
                            readOnly: false
                            type: string
                          recurrencePattern:
                            description: |
                              Define a pattern for repeating the notification. This pattern is used to create Notifications after the initial notification as defined in the notificationDate.
                            format: metadata
                            nullable: true
                            properties:
                              numberOfRepetitionsAfterFirstNotification:
                                description: |
                                  The number of times the notification will be repeated after the first Notification. Setting the value 99 will result in repeating the notification indefinite.
                                example: 4
                                format: int32
                                maximum: 99
                                minimum: 1
                                nullable: false
                                readOnly: false
                                type: integer
                              recurrenceNumber:
                                description: |
                                  The number of the recurrence pattern. An example recurrence pattern is: repeat every 2 weeks.
                                example: 2
                                format: int32
                                maximum: 365
                                minimum: 1
                                nullable: false
                                readOnly: false
                                type: integer
                              recurrencePeriod:
                                description: |
                                  The period of the recurrence pattern An example recurrence pattern is: repeat every 2 weeks.
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Weeks
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit a custom notification record
      tags:
        - Custom notification
  /providers/employers/employees/employments/declarations/process:
    patch:
      description: |
        __Activity name :__ PatchProcessDeclarationsByDeclarationId

        Process approved declarations into the payrolling data.

        Please check the description of the status-field in this resource to read about the workflow of declarations.
      operationId: PatchProcessDeclarationsByDeclarationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            pattern: ^Bearer\s[\w-]+$
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              items:
                properties:
                  id:
                    description: The unique identifier (a 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
                  payrollPeriodId:
                    description: |
                      The year and period of the payroll period
                    example: 202004
                    format: int32
                    nullable: false
                    readOnly: false
                    type: integer
                required:
                  - id
                  - payrollPeriodId
              type: array
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Process approved declarations
      tags:
        - Declarations
  /providers/employers/employees/employments/declarations/review:
    patch:
      description: |
        __Activity name :__ PatchReviewDeclarationsByDeclarationIds

        Review (accept or reject) open declarations

        Please check the description of the status-field in this resource to read about the workflow of declarations.
      operationId: PatchReviewDeclarationsByDeclarationIds
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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:
                  action:
                    description: |-
                      The action to perform on the declaration resulting in a change of `declarationStatus`
                      The following transitions are allowed

                      1. Open --> Accept or reject
                      2. Goedgekeurd ---> Process
                      3. Geweigerd ---> No changes possible
                      5. Verwerkt ---> No changes possible
                      6. Onverwerkbaar ---> No changes possible
                    enum:
                      - accept
                      - reject
                    nullable: false
                    readOnly: false
                    type: string
                  id:
                    description: The unique identifier (a 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: array
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Review (accept or reject) open declarations
      tags:
        - Declarations
  "/providers/employers/employees/employments/declarations/{declarationId}":
    get:
      description: |
        __Activity name :__ GetDeclarationsByDeclarationId

        Get the details of a declaration
      operationId: GetDeclarationsByDeclarationId
      parameters:
        - description: The unique identifier of the declaration
          in: path
          name: declarationId
          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 <TOKEN>
            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: 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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            dateOfLastChangeByEmployee:
                              description: The time the declaration was last changed
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            dateOfSubmissionByEmployee:
                              description: The time the declaration was submitted
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            declarationComment:
                              description: The comment left by the employee
                              example: Overwerk project X
                              maxLength: 4000
                              nullable: true
                              readOnly: true
                              type: string
                            declarationDate:
                              description: The date to which the declaration is applicable. As requested by the employee.
                              example: 2017-11-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            declarationStatus:
                              description: |-
                                The current status of the declaration

                                The status is changed by using the PATCH endpoint.
                                1 Open --> Accept or reject 2 Goedgekeurd ---> Process (not yet implemented) 3 Geweigerd ---> No changes possible 5 Verwerkt ---> No changes possible 6 Onverwerkbaar ---> No changes possible
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Open
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              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
                            numberOfUnits:
                              description: The number of units requested
                              example: 8
                              format: double
                              nullable: false
                              pattern: ^(\d{1,3})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            payrollComponent:
                              description: |
                                A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment for the given payroll period. 
                              format: metadata
                              properties:
                                description:
                                  description: |
                                    The description of the payroll component
                                  example: Tijd voor tijd, UREN TVT 130%
                                  maxLength: 14
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  description: |
                                    The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know it by heart.
                                  example: 11
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            processedInPayrollPeriod:
                              description: |
                                If the declaration has been succesfully processed then this object will show the payroll period for which a payrollPeriodData has been created.

                                If the declaration has not yet been processed, then the value of this object will be null.
                              format: metadata
                              nullable: true
                              properties:
                                periodEndDate:
                                  description: |
                                    The last day of the period
                                  example: 2018-01-31
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                periodNumber:
                                  description: |
                                    The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period
                                  example: 1
                                  format: int32
                                  maximum: 53
                                  minimum: 1
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                periodStartDate:
                                  description: |
                                    The first day of the period
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                year:
                                  description: |
                                    The year of the payroll period
                                  example: 2017
                                  format: int32
                                  maximum: 9999
                                  minimum: 2000
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 declaration
      tags:
        - Declarations
  "/providers/employers/employees/employments/declarations/{declarationId}/attachment":
    get:
      description: |
        __Activity name :__ GetAttachmentByDeclarationId

        Download the attachment (via Qwoater) for the given declarationId. In case no attachment is know the service will return a 404.
      operationId: GetAttachmentByDeclarationId
      parameters:
        - description: The unique identifier of the declaration
          in: path
          name: declarationId
          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 <TOKEN>
            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 attachment
      tags:
        - Declarations attachments
  "/providers/employers/employees/employments/declarations/{declarationId}/audittrail":
    get:
      description: |
        __Activity name :__ GetDeclarationAuditTrailByDeclarationId

        Get the audit trail of a declaration
      operationId: GetDeclarationAuditTrailByDeclarationId
      parameters:
        - description: The unique identifier of the declaration
          in: path
          name: declarationId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            comment:
                              description: The comment for the action
                              example: Approved
                              maxLength: 4000
                              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
                            performedBy:
                              format: metadata
                              nullable: false
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            performedOn:
                              description: The date-time to which the action was performed
                              example: 2017-11-01
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            status:
                              description: The status after the action was performed
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Approved
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Audit trail of a declaration
      tags:
        - Declarations
  "/providers/employers/employees/employments/deviatingawfcontributions/{deviatingAwfContributionId}":
    delete:
      description: |
        __Activity name:__ DeleteDeviatingAwfContributionByDeviatingAwfContributionId

        Delete a Deviating AWF contribution record for the employment
      operationId: DeleteDeviatingAwfContributionByDeviatingAwfContributionId
      parameters:
        - description: The unique identifier of the Deviating AWF contribution record
          in: path
          name: deviatingAwfContributionId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 Deviating AWF contributions record
      tags:
        - Deviating AWF Contribution
    get:
      description: |
        __Activity name:__ GetDeviatingAwfContributionByDeviatingAwfContributionId

        Get the details of a Deviating AWF contributions record
      operationId: GetDeviatingAwfContributionByDeviatingAwfContributionId
      parameters:
        - description: The unique identifier of the Deviating AWF contribution record
          in: path
          name: deviatingAwfContributionId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          endPeriod:
                            format: metadata
                            nullable: true
                            properties:
                              periodEndDate:
                                description: |
                                  The last day of the payroll period.
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: |
                                  The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                example: 1
                                format: int32
                                maximum: 53
                                minimum: 1
                                nullable: false
                                readOnly: false
                                type: integer
                              periodStartDate:
                                description: |
                                  The first day of the payroll period.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: |
                                  The year of the last payroll period for which the record is applicable.
                                example: 2017
                                format: int32
                                maximum: 9999
                                minimum: 2000
                                nullable: false
                                readOnly: false
                                type: integer
                            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
                          startPeriod:
                            format: metadata
                            nullable: false
                            properties:
                              periodEndDate:
                                description: |
                                  The last day of the payroll period.
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: |
                                  The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the record is applicable.
                                example: 1
                                format: int32
                                maximum: 53
                                minimum: 1
                                nullable: false
                                readOnly: false
                                type: integer
                              periodStartDate:
                                description: |
                                  The first day of the payroll period.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: |
                                  The year of the first payroll period for which the record is applicable.
                                example: 2017
                                format: int32
                                maximum: 9999
                                minimum: 2000
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          typeOfDeviatingAwfContribution:
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: The type of deviating Deviating AWF contribution to be applied for this employment.
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: Description of the nationality
                                example: Hoog
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 Deviating AWF contributions record
      tags:
        - Deviating AWF Contribution
    put:
      description: |
        __Activity name:__ PutDeviatingAwfContributionByDeviatingAwfContributionId
        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.

        Edit the details for a Deviating AWF contribution record
      operationId: PutDeviatingAwfContributionByDeviatingAwfContributionId
      parameters:
        - description: The unique identifier of the Deviating AWF contribution record
          in: path
          name: deviatingAwfContributionId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              nullable: false
              properties:
                endPeriod:
                  format: metadata
                  nullable: true
                  properties:
                    periodEndDate:
                      description: |
                        The last day of the payroll period.
                      example: 2018-01-31
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    periodNumber:
                      description: |
                        The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                      example: 1
                      format: int32
                      maximum: 53
                      minimum: 1
                      nullable: false
                      readOnly: false
                      type: integer
                    periodStartDate:
                      description: |
                        The first day of the payroll period.
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    year:
                      description: |
                        The year of the last payroll period for which the record is applicable.
                      example: 2017
                      format: int32
                      maximum: 9999
                      minimum: 2000
                      nullable: false
                      readOnly: false
                      type: integer
                  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
                startPeriod:
                  format: metadata
                  nullable: false
                  properties:
                    periodEndDate:
                      description: |
                        The last day of the payroll period.
                      example: 2018-01-31
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    periodNumber:
                      description: |
                        The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the record is applicable.
                      example: 1
                      format: int32
                      maximum: 53
                      minimum: 1
                      nullable: false
                      readOnly: false
                      type: integer
                    periodStartDate:
                      description: |
                        The first day of the payroll period.
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    year:
                      description: |
                        The year of the first payroll period for which the record is applicable.
                      example: 2017
                      format: int32
                      maximum: 9999
                      minimum: 2000
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
                typeOfDeviatingAwfContribution:
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      description: The type of deviating Deviating AWF contribution to be applied for this employment.
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: Description of the nationality
                      example: Hoog
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
              type: object
        description: Deviating AWF Contribution record 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          endPeriod:
                            format: metadata
                            nullable: true
                            properties:
                              periodEndDate:
                                description: |
                                  The last day of the payroll period.
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: |
                                  The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                example: 1
                                format: int32
                                maximum: 53
                                minimum: 1
                                nullable: false
                                readOnly: false
                                type: integer
                              periodStartDate:
                                description: |
                                  The first day of the payroll period.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: |
                                  The year of the last payroll period for which the record is applicable.
                                example: 2017
                                format: int32
                                maximum: 9999
                                minimum: 2000
                                nullable: false
                                readOnly: false
                                type: integer
                            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
                          startPeriod:
                            format: metadata
                            nullable: false
                            properties:
                              periodEndDate:
                                description: |
                                  The last day of the payroll period.
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: |
                                  The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the record is applicable.
                                example: 1
                                format: int32
                                maximum: 53
                                minimum: 1
                                nullable: false
                                readOnly: false
                                type: integer
                              periodStartDate:
                                description: |
                                  The first day of the payroll period.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: |
                                  The year of the first payroll period for which the record is applicable.
                                example: 2017
                                format: int32
                                maximum: 9999
                                minimum: 2000
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          typeOfDeviatingAwfContribution:
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: The type of deviating Deviating AWF contribution to be applied for this employment.
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: Description of the nationality
                                example: Hoog
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a Deviating AWF contributions record
      tags:
        - Deviating AWF Contribution
  "/providers/employers/employees/employments/deviatinghourlywages/{deviatingHourlyWageId}":
    delete:
      description: |
        __Activity name :__ DeleteDeviatingHourlyWageByDeviatingHourlyWageId

        Delete an existing deviating hourly wage record
      operationId: DeleteDeviatingHourlyWageByDeviatingHourlyWageId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: deviatingHourlyWageId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 deviating hourly wage record
      tags:
        - Deviating hourly wage
    get:
      description: |
        __Activity name :__ GetDeviatingHourlyWageByDeviatingHourlyWageId

        Get the details of a deviating hourly wage
      operationId: GetDeviatingHourlyWageByDeviatingHourlyWageId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: deviatingHourlyWageId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              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
                            payrollComponent:
                              description: |
                                A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                                `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                description:
                                  description: |
                                    The description of the payroll component
                                  example: LOON/SALARIS
                                  maxLength: 14
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  description: |
                                    The number for the payroll component.
                                  example: 70
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            startDate:
                              description: |-
                                The date on which this DeviatingHouryWage starts.

                                A (broken chain)[./#section/Data/Date-chains] per DeviatingHouryWage is maintained within this resource. So multiple DeviatingHouryWages can be active at the same time but one specific DeviatingHouryWage can never be active multiple times at the same time.
                              example: 2018-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            value:
                              description: |
                                The value for the selected payroll component.
                              example: 50.87
                              maximum: 99999.99
                              minimum: 0.01
                              nullable: false
                              pattern: ^(\d{1,5})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 deviating hourly wage
      tags:
        - Deviating hourly wage
    put:
      description: |
        __Activity name :__ PutDeviatingHourlyWageByDeviatingHourlyWageId

        __Metadata :__ No metadata as `payrollComponent` is read only in the PUT.
      operationId: PutDeviatingHourlyWageByDeviatingHourlyWageId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: deviatingHourlyWageId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  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
                payrollComponent:
                  description: |
                    A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                    `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    description:
                      description: |
                        The description of the payroll component
                      example: LOON/SALARIS
                      maxLength: 14
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      description: |
                        The number for the payroll component.
                      example: 70
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  readOnly: true
                  type: object
                startDate:
                  description: |-
                    The date on which this DeviatingHouryWage starts.

                    A (broken chain)[./#section/Data/Date-chains] per DeviatingHouryWage is maintained within this resource. So multiple DeviatingHouryWages can be active at the same time but one specific DeviatingHouryWage can never be active multiple times at the same time.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                value:
                  description: |
                    The value for the selected payroll component.
                  example: 50.87
                  maximum: 99999.99
                  minimum: 0.01
                  nullable: false
                  pattern: ^(\d{1,5})(\.\d{1,2})?$
                  readOnly: false
                  type: number
              type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            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
                          payrollComponent:
                            description: |
                              A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                              `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                description: |
                                  The description of the payroll component
                                example: LOON/SALARIS
                                maxLength: 14
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                description: |
                                  The number for the payroll component.
                                example: 70
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          startDate:
                            description: |-
                              The date on which this DeviatingHouryWage starts.

                              A (broken chain)[./#section/Data/Date-chains] per DeviatingHouryWage is maintained within this resource. So multiple DeviatingHouryWages can be active at the same time but one specific DeviatingHouryWage can never be active multiple times at the same time.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          value:
                            description: |
                              The value for the selected payroll component.
                            example: 50.87
                            maximum: 99999.99
                            minimum: 0.01
                            nullable: false
                            pattern: ^(\d{1,5})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit a deviating hourly wage record
      tags:
        - Deviating hourly wage
  "/providers/employers/employees/employments/employmentfunds/{employmentFundId}":
    delete:
      description: |
        __Activity name :__ DeleteEmploymentFundByEmploymentFundId

        Delete an existing employment fund record.
      operationId: DeleteEmploymentFundByEmploymentFundId
      parameters:
        - description: The unique identifier of the employment fund
          in: path
          name: employmentFundId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employment fund record
      tags:
        - Employment funds
    get:
      description: |
        __Activity name :__ GetEmploymentFundByEmploymentFundId

        Get the details of an employment fund
      operationId: GetEmploymentFundByEmploymentFundId
      parameters:
        - description: The unique identifier of the employment fund
          in: path
          name: employmentFundId
          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 <TOKEN>
            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:
              examples:
                example1:
                  value:
                    content:
                      deviations: null
                      endDate: 2018-10-23
                      fixedContribution: null
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
                example2:
                  value:
                    content:
                      deviations:
                        employmentContributionPercentage: "1.0000"
                        totalContributionPercentage: "12.0007"
                      endDate: 2018-10-23
                      fixedContribution: null
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
                example3:
                  value:
                    content:
                      deviations: null
                      endDate: 2018-10-23
                      fixedContribution:
                        employmentContribution: "1789.00"
                        totalContribution: "2569.00"
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            deviations:
                              description: |-
                                Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`.

                                Deviating is done on either all the fields or none.

                                __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                              nullable: true
                              properties:
                                employmentContributionPercentage:
                                  description: |-
                                    Deviating employment contribution percentage. This value will overrule the value of the selected `fund`. Indicates percentage wise how much the employment has to contribute to the payment of the "fund" contribution.

                                    __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                                  example: 11
                                  format: double
                                  maximum: 100
                                  minimum: 0
                                  nullable: false
                                  pattern: ^(\d{1,3})(\.\d{1,4})?$
                                  readOnly: false
                                  type: number
                                totalContributionPercentage:
                                  description: |-
                                    Deviating total contribution percentage. This value will overrule the value of the selected `fund`. The difference between `employmentContributionPercentage` and `totalContributionPercentage` will be paid by the employer.

                                    __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                                  example: 12.0007
                                  format: double
                                  maximum: 100
                                  minimum: 0
                                  nullable: false
                                  pattern: ^(\d{1,3})(\.\d{1,4})?$
                                  readOnly: false
                                  type: number
                              readOnly: false
                              type: object
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              format: date
                              nullable: true
                              readOnly: false
                              type: string
                            fixedContribution:
                              description: |-
                                With the underlying elements fixed values (money) can be set as the result of the Fund calculation.  In doing so the actual calculation for the `fund` will no longer take place as the outcome is fixed. This has the side effect that the "grondslag" is no longer calculated.  In the data exchange with certain parties the "grondslag" has to be communicated allongside the contribution.  In those cases do not use this option as the calculation is disabled.

                                Setting a fixed contribution is done on either all the fields or none.

                                __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                              nullable: true
                              properties:
                                employmentContribution:
                                  description: |-
                                    The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates.

                                    __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0.00 up to 9999.99
                                  example: 1789
                                  format: double
                                  maximum: 99999999.99
                                  minimum: 0
                                  nullable: false
                                  pattern: ^(\d{1,8})(\.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                totalContribution:
                                  description: |-
                                    The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates.

                                    __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0 up to 9999.99
                                  example: 2569
                                  format: double
                                  maximum: 99999999.99
                                  minimum: 0
                                  nullable: false
                                  pattern: ^(\d{1,8})(\.\d{1,2})?$
                                  readOnly: false
                                  type: number
                              readOnly: false
                              type: object
                            fund:
                              format: metadata
                              properties:
                                description:
                                  description: |
                                    The description of the fund
                                  example: Ouderdomspensioen
                                  maxLength: 255
                                  minLength: 1
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  description: |
                                    The key for the fund
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              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
                            startDate:
                              description: |-
                                The date on which this fund starts.

                                A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time.
                              example: 2018-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employment fund
      tags:
        - Employment funds
    put:
      description: |
        __Activity name :__ PutEmploymentFundByEmploymentFundId

        __Metadata :__ Possible options for fields of the type "metadata" can be acquired (GET) by adding `/metadata` to the PUT URL.
      operationId: PutEmploymentFundByEmploymentFundId
      parameters:
        - description: The unique identifier of the employment fund
          in: path
          name: employmentFundId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            examples:
              example1:
                value:
                  deviations: null
                  endDate: 2018-10-23
                  fixedContribution: null
                  startDate: 2018-01-01
              example2:
                value:
                  deviations:
                    employmentContributionPercentage: "11.0000"
                    totalContributionPercentage: "12.0007"
                  endDate: 2018-10-23
                  fixedContribution: null
                  startDate: 2018-01-01
              example3:
                value:
                  deviations: null
                  endDate: 2018-10-23
                  fixedContribution:
                    employmentContribution: "1789.00"
                    totalContribution: "2569.00"
                  startDate: 2018-01-01
            schema:
              properties:
                deviations:
                  description: |-
                    Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`.

                    Deviating is done on either all the fields or none.

                    __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                  nullable: true
                  properties:
                    employmentContributionPercentage:
                      description: Deviating employment contribution percentage. This value will overrule the value of the selected `fund`. Indicates percentage wise how much the employment has to contribute to the payment of the "fund" contribution.
                      example: 11
                      format: double
                      maximum: 100
                      minimum: 0
                      nullable: false
                      pattern: ^(\d{1,2})(\.\d{1,4})?$
                      readOnly: false
                      type: number
                    totalContributionPercentage:
                      description: Deviating total contribution percentage. This value will overrule the value of the selected `fund`. The difference between `employmentContributionPercentage` and `totalContributionPercentage` will be paid by the employer.
                      example: 12.0007
                      format: double
                      maximum: 100
                      minimum: 0
                      nullable: false
                      pattern: ^(\d{1,2})(\.\d{1,4})?$
                      readOnly: false
                      type: number
                  readOnly: false
                  type: object
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                fixedContribution:
                  description: |-
                    With the underlying elements fixed values (money) can be set as the result of the Fund calculation.  In doing so the actual calculation for the `fund` will no longer take place as the outcome is fixed. This has the side effect that the "grondslag" is no longer calculated.  In the data exchange with certain parties the "grondslag" has to be communicated allongside the contribution.  In those cases do not use this option as the calculation is disabled.

                    Setting a fixed contribution is done on either all the fields or none.

                    __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                  nullable: true
                  properties:
                    employmentContribution:
                      description: The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates.
                      example: 1789
                      format: double
                      maximum: 99999999.99
                      minimum: 0
                      nullable: false
                      pattern: ^(\d{1,8})(\.\d{1,2})?$
                      readOnly: false
                      type: number
                    totalContribution:
                      description: The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates.
                      example: 2569
                      format: double
                      maximum: 99999999.99
                      minimum: 0
                      nullable: false
                      pattern: ^(\d{1,8})(\.\d{1,2})?$
                      readOnly: false
                      type: number
                  readOnly: false
                  type: object
                fund:
                  format: metadata
                  properties:
                    description:
                      description: |
                        The description of the fund
                      example: Ouderdomspensioen
                      maxLength: 255
                      minLength: 1
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      description: |
                        The key for the fund
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                  readOnly: true
                  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
                startDate:
                  description: |-
                    The date on which this fund starts.

                    A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
        required: true
      responses:
        "200":
          content:
            application/json;version=2018-01-01:
              examples:
                example1:
                  value:
                    content:
                      deviations: null
                      endDate: 2018-10-23
                      fixedContribution: null
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
                example2:
                  value:
                    content:
                      deviations:
                        employmentContributionPercentage: "1.0000"
                        totalContributionPercentage: "12.0007"
                      endDate: 2018-10-23
                      fixedContribution: null
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
                example3:
                  value:
                    content:
                      deviations: null
                      endDate: 2018-10-23
                      fixedContribution:
                        employmentContribution: "1789.00"
                        totalContribution: "2569.00"
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          deviations:
                            description: |-
                              Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`.

                              Deviating is done on either all the fields or none.

                              __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                            nullable: true
                            properties:
                              employmentContributionPercentage:
                                description: |-
                                  Deviating employment contribution percentage. This value will overrule the value of the selected `fund`. Indicates percentage wise how much the employment has to contribute to the payment of the "fund" contribution.

                                  __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                                example: 11
                                format: double
                                maximum: 100
                                minimum: 0
                                nullable: false
                                pattern: ^(\d{1,3})(\.\d{1,4})?$
                                readOnly: false
                                type: number
                              totalContributionPercentage:
                                description: |-
                                  Deviating total contribution percentage. This value will overrule the value of the selected `fund`. The difference between `employmentContributionPercentage` and `totalContributionPercentage` will be paid by the employer.

                                  __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                                example: 12.0007
                                format: double
                                maximum: 100
                                minimum: 0
                                nullable: false
                                pattern: ^(\d{1,3})(\.\d{1,4})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          fixedContribution:
                            description: |-
                              With the underlying elements fixed values (money) can be set as the result of the Fund calculation.  In doing so the actual calculation for the `fund` will no longer take place as the outcome is fixed. This has the side effect that the "grondslag" is no longer calculated.  In the data exchange with certain parties the "grondslag" has to be communicated allongside the contribution.  In those cases do not use this option as the calculation is disabled.

                              Setting a fixed contribution is done on either all the fields or none.

                              __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                            nullable: true
                            properties:
                              employmentContribution:
                                description: |-
                                  The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates.

                                  __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0.00 up to 9999.99
                                example: 1789
                                format: double
                                maximum: 99999999.99
                                minimum: 0
                                nullable: false
                                pattern: ^(\d{1,8})(\.\d{1,2})?$
                                readOnly: false
                                type: number
                              totalContribution:
                                description: |-
                                  The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates.

                                  __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0 up to 9999.99
                                example: 2569
                                format: double
                                maximum: 99999999.99
                                minimum: 0
                                nullable: false
                                pattern: ^(\d{1,8})(\.\d{1,2})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          fund:
                            format: metadata
                            properties:
                              description:
                                description: |
                                  The description of the fund
                                example: Ouderdomspensioen
                                maxLength: 255
                                minLength: 1
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                description: |
                                  The key for the fund
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            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
                          startDate:
                            description: |-
                              The date on which this fund starts.

                              A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time.
                            example: 2018-01-01
                            format: date
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit a employment fund record
      tags:
        - Employment funds
  "/providers/employers/employees/employments/fiscalcompanycars/{fiscalCompanyCarId}":
    delete:
      description: |
        __Activity name:__ DeleteFiscalCompanyCarByFiscalCompanyCarId

        Delete a fiscal company car record for the employment

        Please note this resource is related for the registration of the company car for tax purposes. This is NOT directly related to the registration of the company car(s) related to the HRM-module Verstrekking
      operationId: DeleteFiscalCompanyCarByFiscalCompanyCarId
      parameters:
        - description: The unique identifier of the fiscal company car
          in: path
          name: fiscalCompanyCarId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 fiscal company car record
      tags:
        - Fiscal company car
    get:
      description: |
        __Activity name:__ GetFiscalCompanyCarByFiscalCompanyCarId


         Get the details of fiscal company car 


         Please note this resource is related for the registration of the company car for tax purposes.
         This is NOT directly related to the registration of the company car(s) related to the HRM-module Verstrekking
      operationId: GetFiscalCompanyCarByFiscalCompanyCarId
      parameters:
        - description: The unique identifier of the fiscal company car
          in: path
          name: fiscalCompanyCarId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          additionalTaxLiabilityGroup:
                            description: |
                              Indication for what additional tax liability percentage (bijtelling) should be used for calculating the tax liabiltiy in the payroll process.

                              It is possible to acquire a value for this field based on the RDW-registration of the vehicle registration number (license plate) by calling that supplementary endpoint.
                            format: metaData
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Standaard tarief (25% tot 2017)
                                maxLength: 100
                                minLength: 0
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          dateOfFirstAdmission:
                            description: First day of admission for the vehicle (datum eerste toelating). It is possible to acquire a value for this field based on the RDW-registration by calling that supplementary endpoint.
                            example: 2018-01-01
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          deviatingAdditionalTaxLiability:
                            description: |
                              Normally Loket will calculate the applicable tax liability based on the value and tax liability group of the car. However this field may OVERRIDE any other values, and in that case this amount will be applied as the applicable tax liability amount.
                            example: 20000
                            format: double
                            maximum: 999999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,6})(.\d{1,2})?$
                            readOnly: false
                            type: number
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2023-10-23
                            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
                          licensePlateNumber:
                            description: |
                              Vehicle registration number (license plate) of the fiscal company car. The number should be provided with or without any hyphens (-).
                            example: GP586D
                            maxLength: 15
                            minLength: 0
                            nullable: true
                            readOnly: false
                            type: string
                          reasonForNoAdditionalTaxLiability:
                            description: |
                              In case the employment does have a fiscal company car but no additional tax liability should be applied, then the reason should be provided for the payroll tax return.
                            format: metaData
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: (2) Werknemer heeft beschikking belastingdienst
                                maxLength: 50
                                minLength: 0
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          startDate:
                            description: |-
                              The start date of the entity.

                              A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2021-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          taxableBenefitForPrivateUse:
                            description: |
                              Taxable benefit for private use (eigen bijdrage van de werknemer) may be entered here, this will lower the tax liability to be paid in the payrolling process.
                            example: 2000
                            format: double
                            maximum: 999999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,6})(.\d{1,2})?$
                            readOnly: false
                            type: number
                          valueForTaxPurposes:
                            description: |
                              The value of the car for tax purposes. This field may only be NULL if a reason for no additional tax liability (reden voor geen bijtelling) is provided.
                              It is possible to acquire a value for this field based on the RDW-registration by calling that supplementary endpoint.
                            example: 20000
                            format: double
                            maximum: 999999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,6})(.\d{1,2})?$
                            readOnly: false
                            type: number
                        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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 fiscal company car record
      tags:
        - Fiscal company car
    put:
      description: |
        __Activity name:__ PutFiscalCompanyCarByFiscalCompanyCarId


         Edit the details for a fiscal company car record.


         Please note this resource is related for the registration of the company car for tax purposes.
         This is NOT directly related to the registration of the company car(s) related to the HRM-module Verstrekking


         __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.
      operationId: PutFiscalCompanyCarByFiscalCompanyCarId
      parameters:
        - description: The unique identifier of the fiscal company car
          in: path
          name: fiscalCompanyCarId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              nullable: true
              properties:
                additionalTaxLiabilityGroup:
                  description: |
                    Indication for what additional tax liability percentage (bijtelling) should be used for calculating the tax liabiltiy in the payroll process.

                    It is possible to acquire a value for this field based on the RDW-registration of the vehicle registration number (license plate) by calling that supplementary endpoint.
                  format: metaData
                  nullable: false
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Standaard tarief (25% tot 2017)
                      maxLength: 100
                      minLength: 0
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                dateOfFirstAdmission:
                  description: First day of admission for the vehicle (datum eerste toelating). It is possible to acquire a value for this field based on the RDW-registration by calling that supplementary endpoint.
                  example: 2018-01-01
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                deviatingAdditionalTaxLiability:
                  description: |
                    Normally Loket will calculate the applicable tax liability based on the value and tax liability group of the car. However this field may OVERRIDE any other values, and in that case this amount will be applied as the applicable tax liability amount.
                  example: 20000
                  format: double
                  maximum: 999999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,6})(.\d{1,2})?$
                  readOnly: false
                  type: number
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2023-10-23
                  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
                licensePlateNumber:
                  description: |
                    Vehicle registration number (license plate) of the fiscal company car. The number should be provided with or without any hyphens (-).
                  example: GP586D
                  maxLength: 15
                  minLength: 0
                  nullable: true
                  readOnly: false
                  type: string
                reasonForNoAdditionalTaxLiability:
                  description: |
                    In case the employment does have a fiscal company car but no additional tax liability should be applied, then the reason should be provided for the payroll tax return.
                  format: metaData
                  nullable: true
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: (2) Werknemer heeft beschikking belastingdienst
                      maxLength: 50
                      minLength: 0
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                startDate:
                  description: |-
                    The start date of the entity.

                    A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                  example: 2021-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                taxableBenefitForPrivateUse:
                  description: |
                    Taxable benefit for private use (eigen bijdrage van de werknemer) may be entered here, this will lower the tax liability to be paid in the payrolling process.
                  example: 2000
                  format: double
                  maximum: 999999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,6})(.\d{1,2})?$
                  readOnly: false
                  type: number
                valueForTaxPurposes:
                  description: |
                    The value of the car for tax purposes. This field may only be NULL if a reason for no additional tax liability (reden voor geen bijtelling) is provided.
                    It is possible to acquire a value for this field based on the RDW-registration by calling that supplementary endpoint.
                  example: 20000
                  format: double
                  maximum: 999999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,6})(.\d{1,2})?$
                  readOnly: false
                  type: number
              type: object
        description: Company Car 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          additionalTaxLiabilityGroup:
                            description: |
                              Indication for what additional tax liability percentage (bijtelling) should be used for calculating the tax liabiltiy in the payroll process.

                              It is possible to acquire a value for this field based on the RDW-registration of the vehicle registration number (license plate) by calling that supplementary endpoint.
                            format: metaData
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Standaard tarief (25% tot 2017)
                                maxLength: 100
                                minLength: 0
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          dateOfFirstAdmission:
                            description: First day of admission for the vehicle (datum eerste toelating). It is possible to acquire a value for this field based on the RDW-registration by calling that supplementary endpoint.
                            example: 2018-01-01
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          deviatingAdditionalTaxLiability:
                            description: |
                              Normally Loket will calculate the applicable tax liability based on the value and tax liability group of the car. However this field may OVERRIDE any other values, and in that case this amount will be applied as the applicable tax liability amount.
                            example: 20000
                            format: double
                            maximum: 999999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,6})(.\d{1,2})?$
                            readOnly: false
                            type: number
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2023-10-23
                            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
                          licensePlateNumber:
                            description: |
                              Vehicle registration number (license plate) of the fiscal company car. The number should be provided with or without any hyphens (-).
                            example: GP586D
                            maxLength: 15
                            minLength: 0
                            nullable: true
                            readOnly: false
                            type: string
                          reasonForNoAdditionalTaxLiability:
                            description: |
                              In case the employment does have a fiscal company car but no additional tax liability should be applied, then the reason should be provided for the payroll tax return.
                            format: metaData
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: (2) Werknemer heeft beschikking belastingdienst
                                maxLength: 50
                                minLength: 0
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          startDate:
                            description: |-
                              The start date of the entity.

                              A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2021-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          taxableBenefitForPrivateUse:
                            description: |
                              Taxable benefit for private use (eigen bijdrage van de werknemer) may be entered here, this will lower the tax liability to be paid in the payrolling process.
                            example: 2000
                            format: double
                            maximum: 999999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,6})(.\d{1,2})?$
                            readOnly: false
                            type: number
                          valueForTaxPurposes:
                            description: |
                              The value of the car for tax purposes. This field may only be NULL if a reason for no additional tax liability (reden voor geen bijtelling) is provided.
                              It is possible to acquire a value for this field based on the RDW-registration by calling that supplementary endpoint.
                            example: 20000
                            format: double
                            maximum: 999999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,6})(.\d{1,2})?$
                            readOnly: false
                            type: number
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a fiscal company car record
      tags:
        - Fiscal company car
  "/providers/employers/employees/employments/fiscalproperties/{fiscalPropertiesId}":
    delete:
      description: |
        __Activity name:__ DeleteFiscalPropertiesByFiscalPropertiesId

        Delete a fiscal properties record for the employment
      operationId: DeleteFiscalPropertiesByFiscalPropertiesId
      parameters:
        - description: The unique identifier of the fiscal properties record
          in: path
          name: fiscalPropertiesId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 fiscal properties record
      tags:
        - Fiscal properties
    get:
      description: |
        __Activity name:__ GetFiscalPropertiesByFiscalPropertiesId

        Get the details of fiscal
      operationId: GetFiscalPropertiesByFiscalPropertiesId
      parameters:
        - description: The unique identifier of the fiscal properties record
          in: path
          name: fiscalPropertiesId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          annualSalary:
                            description: "The fiscal annual salary. NL: Fiscaal jaarloon"
                            example: 60000
                            format: double
                            maximum: 999999999
                            minimum: 0
                            nullable: false
                            pattern: ^(\d{0,9})$
                            readOnly: false
                            type: number
                          applyDayTables:
                            description: "Indicates whether the value of the day table is used for the calculation of payroll tax. NL: DagtabelToepassen"
                            example: false
                            nullable: true
                            readOnly: false
                            type: boolean
                          applyDeviatingPayrollTaxPercentageOn:
                            description: "Indicates on what type of payroll calculation the deviating payroll tax percentage is applicable. NL: AfwijkendPercentageToepassen"
                            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). NL: ArbeidskortingToepassen"
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          applySalarysplit:
                            description: |
                              Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                              value:
                                description: Description of the type of document
                                example: LB obv wereldinkomen (%NL/WI)
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          applyStudentDeduction:
                            description: Apply the "Scholierenregeling". NL; ArbeidskortingToepassen
                            example: false
                            nullable: true
                            readOnly: false
                            type: boolean
                          contributionReductionEducation:
                            description: |
                              Afdr. verm. onderwijs
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                              value:
                                description: Description of the type of education
                                example: 4. Opleiding hbo
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          deviatingCalculationRulePayrollTax:
                            description: Indicates if, while calculating payroll taxes and social security contributions, certain deviations are applicable. NL; Herleidingsregel
                            format: metadata
                            nullable: false
                            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 the deviating payroll tax percentage which is to be applied. NL: AfwijkendLoonbelastingPercentage"
                            example: 25
                            format: double
                            maximum: 99.99
                            minimum: 0
                            nullable: true
                            pattern: ^(\d{1,2})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          deviatingPayrollTaxTableColour:
                            description: "Indicates if there is a deviating payroll tax table is applicable (green vs white table). If 'Niet afwijkend', then the colour is based on the setting at the payroll administration level, either green or white. NL: AfwijkendeKleurLBtabel"
                            format: metadata
                            nullable: false
                            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
                          deviatingPercentageThirtyPercentFacility:
                            description: Indicates a deviating percentage which should be applied for the 30% facility (30%-regeling)
                            example: 20.2345
                            format: double
                            maximum: 29.999999
                            minimum: 0.000001
                            nullable: true
                            pattern: ^(\d{1,2})(\.\d{1,6})?$
                            readOnly: false
                            type: number
                          deviatingSmallJobsArrangement:
                            description: Kleine banenregeling
                            example: false
                            nullable: true
                            readOnly: false
                            type: boolean
                          deviatingTaxTableCode:
                            description: "Indicates if the tax tabel code should be set to a specific code (code loonbelasting). Normally Loket will determine the tax table based on other properties of the employment, however this field allows the user to override this and set the tax table code to 999. Only in exceptional cases this field should have a value. NL: CodeLoonBelastingtabel"
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: 999 Overige gevallen waarin geen tabel is toegepast
                                maxLength: 80
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          doesWageIncludeAow:
                            description: "Indicates whether wage include AOW pension (affects payrolling). NL: LoonInclusiefAowUitkering"
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          doesWageIncludeWajong:
                            description: "Indicates whether wage include Wajong benefits (affects payrolling). NL: LoonInclusiefWajong"
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          hasEmployeeLoan:
                            description: Whether an employee loan (Personeelslening) is applicable may be indicated here. The Personeelslening indirectly affects the income tax calculations.
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          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
                          percentageForeignIncome:
                            description: "Indicates what percentage of the income of this employment is taxable outside the Netherlands. NL: PercentageBuitenlandsInkomen"
                            example: 50
                            format: double
                            maximum: 99.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,2})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          residentOf:
                            description: |
                              Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen. NL: InwonerVan
                            format: metadata
                            nullable: false
                            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
                          specialIndication:
                            description: Indications This field is no longer used sinds 2005
                            properties:
                              four:
                                description: Speciale aanduiding 4
                                example: 1
                                format: int32
                                nullable: true
                                readOnly: true
                                type: integer
                              one:
                                description: Speciale aanduiding 1
                                example: 1
                                format: int32
                                nullable: true
                                readOnly: true
                                type: integer
                              three:
                                description: Speciale aanduiding 3
                                example: 1
                                format: int32
                                nullable: true
                                readOnly: true
                                type: integer
                              two:
                                description: Speciale aanduiding 2
                                example: 1
                                format: int32
                                nullable: true
                                readOnly: true
                                type: integer
                            readOnly: true
                            type: object
                          startDate:
                            description: |-
                              The start date of the entity.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          thirtyPercentFacility:
                            description: If the employee comes to work in the Netherlands from another country, the employer may grant an untaxed reimbursement. (30%-regeling).
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Netto
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          usesTransportByWithholdingAgent:
                            description: The so-called 'vervoer vanwege inhoudingsplichtige' is a tax rule that may apply. By example when the employer organizes the transport for the employee.
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                        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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 fiscal record
      tags:
        - Fiscal properties
    put:
      description: |
        __Activity name:__ PutFiscalPropertiesByFiscalPropertiesId

        Edit the details for a fiscal properties record

        Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.
      operationId: PutFiscalPropertiesByFiscalPropertiesId
      parameters:
        - description: The unique identifier of the fiscal properties record
          in: path
          name: fiscalPropertiesId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              nullable: true
              properties:
                annualSalary:
                  description: "The fiscal annual salary. NL: Fiscaal jaarloon"
                  example: 60000
                  format: double
                  maximum: 999999999
                  minimum: 0
                  nullable: false
                  pattern: ^(\d{0,9})$
                  readOnly: false
                  type: number
                applyDayTables:
                  description: "Indicates whether the value of the day table is used for the calculation of payroll tax. NL: DagtabelToepassen"
                  example: false
                  nullable: true
                  readOnly: false
                  type: boolean
                applyDeviatingPayrollTaxPercentageOn:
                  description: "Indicates on what type of payroll calculation the deviating payroll tax percentage is applicable. NL: AfwijkendPercentageToepassen"
                  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). NL: ArbeidskortingToepassen"
                  example: true
                  nullable: false
                  readOnly: false
                  type: boolean
                applySalarysplit:
                  description: |
                    Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen.
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                    value:
                      description: Description of the type of document
                      example: LB obv wereldinkomen (%NL/WI)
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                applyStudentDeduction:
                  description: Apply the "Scholierenregeling". NL; ArbeidskortingToepassen
                  example: false
                  nullable: true
                  readOnly: false
                  type: boolean
                contributionReductionEducation:
                  description: |
                    Afdr. verm. onderwijs
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                    value:
                      description: Description of the type of education
                      example: 4. Opleiding hbo
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                deviatingCalculationRulePayrollTax:
                  description: Indicates if, while calculating payroll taxes and social security contributions, certain deviations are applicable. NL; Herleidingsregel
                  format: metadata
                  nullable: false
                  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 the deviating payroll tax percentage which is to be applied. NL: AfwijkendLoonbelastingPercentage"
                  example: 25
                  format: double
                  maximum: 99.99
                  minimum: 0
                  nullable: true
                  pattern: ^(\d{1,2})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                deviatingPayrollTaxTableColour:
                  description: "Indicates if there is a deviating payroll tax table is applicable (green vs white table). If 'Niet afwijkend', then the colour is based on the setting at the payroll administration level, either green or white. NL: AfwijkendeKleurLBtabel"
                  format: metadata
                  nullable: false
                  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
                deviatingPercentageThirtyPercentFacility:
                  description: Indicates a deviating percentage which should be applied for the 30% facility (30%-regeling)
                  example: 20.2345
                  format: double
                  maximum: 29.999999
                  minimum: 0.000001
                  nullable: true
                  pattern: ^(\d{1,2})(\.\d{1,6})?$
                  readOnly: false
                  type: number
                deviatingSmallJobsArrangement:
                  description: Kleine banenregeling
                  example: false
                  nullable: true
                  readOnly: false
                  type: boolean
                deviatingTaxTableCode:
                  description: "Indicates if the tax tabel code should be set to a specific code (code loonbelasting). Normally Loket will determine the tax table based on other properties of the employment, however this field allows the user to override this and set the tax table code to 999. Only in exceptional cases this field should have a value. NL: CodeLoonBelastingtabel"
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: 999 Overige gevallen waarin geen tabel is toegepast
                      maxLength: 80
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                doesWageIncludeAow:
                  description: "Indicates whether wage include AOW pension (affects payrolling). NL: LoonInclusiefAowUitkering"
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                doesWageIncludeWajong:
                  description: "Indicates whether wage include Wajong benefits (affects payrolling). NL: LoonInclusiefWajong"
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: true
                  type: string
                hasEmployeeLoan:
                  description: Whether an employee loan (Personeelslening) is applicable may be indicated here. The Personeelslening indirectly affects the income tax calculations.
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                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
                percentageForeignIncome:
                  description: "Indicates what percentage of the income of this employment is taxable outside the Netherlands. NL: PercentageBuitenlandsInkomen"
                  example: 50
                  format: double
                  maximum: 99.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,2})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                residentOf:
                  description: |
                    Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen. NL: InwonerVan
                  format: metadata
                  nullable: false
                  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
                specialIndication:
                  description: Indications This field is no longer used sinds 2005
                  properties:
                    four:
                      description: Speciale aanduiding 4
                      example: 1
                      format: int32
                      nullable: true
                      readOnly: true
                      type: integer
                    one:
                      description: Speciale aanduiding 1
                      example: 1
                      format: int32
                      nullable: true
                      readOnly: true
                      type: integer
                    three:
                      description: Speciale aanduiding 3
                      example: 1
                      format: int32
                      nullable: true
                      readOnly: true
                      type: integer
                    two:
                      description: Speciale aanduiding 2
                      example: 1
                      format: int32
                      nullable: true
                      readOnly: true
                      type: integer
                  readOnly: true
                  type: object
                startDate:
                  description: |-
                    The start date of the entity.

                    A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                thirtyPercentFacility:
                  description: If the employee comes to work in the Netherlands from another country, the employer may grant an untaxed reimbursement. (30%-regeling).
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Netto
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                usesTransportByWithholdingAgent:
                  description: The so-called 'vervoer vanwege inhoudingsplichtige' is a tax rule that may apply. By example when the employer organizes the transport for the employee.
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
              type: object
        description: Fiscal 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          annualSalary:
                            description: "The fiscal annual salary. NL: Fiscaal jaarloon"
                            example: 60000
                            format: double
                            maximum: 999999999
                            minimum: 0
                            nullable: false
                            pattern: ^(\d{0,9})$
                            readOnly: false
                            type: number
                          applyDayTables:
                            description: "Indicates whether the value of the day table is used for the calculation of payroll tax. NL: DagtabelToepassen"
                            example: false
                            nullable: true
                            readOnly: false
                            type: boolean
                          applyDeviatingPayrollTaxPercentageOn:
                            description: "Indicates on what type of payroll calculation the deviating payroll tax percentage is applicable. NL: AfwijkendPercentageToepassen"
                            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). NL: ArbeidskortingToepassen"
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          applySalarysplit:
                            description: |
                              Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                              value:
                                description: Description of the type of document
                                example: LB obv wereldinkomen (%NL/WI)
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          applyStudentDeduction:
                            description: Apply the "Scholierenregeling". NL; ArbeidskortingToepassen
                            example: false
                            nullable: true
                            readOnly: false
                            type: boolean
                          contributionReductionEducation:
                            description: |
                              Afdr. verm. onderwijs
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                              value:
                                description: Description of the type of education
                                example: 4. Opleiding hbo
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          deviatingCalculationRulePayrollTax:
                            description: Indicates if, while calculating payroll taxes and social security contributions, certain deviations are applicable. NL; Herleidingsregel
                            format: metadata
                            nullable: false
                            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 the deviating payroll tax percentage which is to be applied. NL: AfwijkendLoonbelastingPercentage"
                            example: 25
                            format: double
                            maximum: 99.99
                            minimum: 0
                            nullable: true
                            pattern: ^(\d{1,2})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          deviatingPayrollTaxTableColour:
                            description: "Indicates if there is a deviating payroll tax table is applicable (green vs white table). If 'Niet afwijkend', then the colour is based on the setting at the payroll administration level, either green or white. NL: AfwijkendeKleurLBtabel"
                            format: metadata
                            nullable: false
                            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
                          deviatingPercentageThirtyPercentFacility:
                            description: Indicates a deviating percentage which should be applied for the 30% facility (30%-regeling)
                            example: 20.2345
                            format: double
                            maximum: 29.999999
                            minimum: 0.000001
                            nullable: true
                            pattern: ^(\d{1,2})(\.\d{1,6})?$
                            readOnly: false
                            type: number
                          deviatingSmallJobsArrangement:
                            description: Kleine banenregeling
                            example: false
                            nullable: true
                            readOnly: false
                            type: boolean
                          deviatingTaxTableCode:
                            description: "Indicates if the tax tabel code should be set to a specific code (code loonbelasting). Normally Loket will determine the tax table based on other properties of the employment, however this field allows the user to override this and set the tax table code to 999. Only in exceptional cases this field should have a value. NL: CodeLoonBelastingtabel"
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: 999 Overige gevallen waarin geen tabel is toegepast
                                maxLength: 80
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          doesWageIncludeAow:
                            description: "Indicates whether wage include AOW pension (affects payrolling). NL: LoonInclusiefAowUitkering"
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          doesWageIncludeWajong:
                            description: "Indicates whether wage include Wajong benefits (affects payrolling). NL: LoonInclusiefWajong"
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          hasEmployeeLoan:
                            description: Whether an employee loan (Personeelslening) is applicable may be indicated here. The Personeelslening indirectly affects the income tax calculations.
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          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
                          percentageForeignIncome:
                            description: "Indicates what percentage of the income of this employment is taxable outside the Netherlands. NL: PercentageBuitenlandsInkomen"
                            example: 50
                            format: double
                            maximum: 99.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,2})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          residentOf:
                            description: |
                              Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen. NL: InwonerVan
                            format: metadata
                            nullable: false
                            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
                          specialIndication:
                            description: Indications This field is no longer used sinds 2005
                            properties:
                              four:
                                description: Speciale aanduiding 4
                                example: 1
                                format: int32
                                nullable: true
                                readOnly: true
                                type: integer
                              one:
                                description: Speciale aanduiding 1
                                example: 1
                                format: int32
                                nullable: true
                                readOnly: true
                                type: integer
                              three:
                                description: Speciale aanduiding 3
                                example: 1
                                format: int32
                                nullable: true
                                readOnly: true
                                type: integer
                              two:
                                description: Speciale aanduiding 2
                                example: 1
                                format: int32
                                nullable: true
                                readOnly: true
                                type: integer
                            readOnly: true
                            type: object
                          startDate:
                            description: |-
                              The start date of the entity.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          thirtyPercentFacility:
                            description: If the employee comes to work in the Netherlands from another country, the employer may grant an untaxed reimbursement. (30%-regeling).
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Netto
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          usesTransportByWithholdingAgent:
                            description: The so-called 'vervoer vanwege inhoudingsplichtige' is a tax rule that may apply. By example when the employer organizes the transport for the employee.
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a fiscal record
      tags:
        - Fiscal properties
  "/providers/employers/employees/employments/healthcareinsuranceactconfigurations/{healthcareInsuranceActConfigurationId}":
    delete:
      description: |
        __Activity name:__ DeleteHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId

        Delete a Healthcare Insurance Act record for the employment
      operationId: DeleteHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId
      parameters:
        - description: The unique identifier of the Healthcare Insurance Act record
          in: path
          name: healthcareInsuranceActConfigurationId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 Healthcare Insurance Act record
      tags:
        - Healthcare Insurance Act
    get:
      description: |
        __Activity name:__ GetHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId

        Get the details of a Healthcare Insurance Act configuration record
      operationId: GetHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId
      parameters:
        - description: The unique identifier of the Healthcare Insurance Act record
          in: path
          name: healthcareInsuranceActConfigurationId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          additionalContributionEmployer:
                            description: If applicable, please enter any additional contribution (extra bijdrage werkgever) for the employer in relation to the Healthcare Insurance Act (Zorgverzekeringswet).
                            example: 320
                            format: double
                            maximum: 9999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,4})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          additionalPremium:
                            description: Additional premium (aanvullende premie) on top of the nomial premium may be registered here, if applicable.
                            example: 120
                            format: double
                            maximum: 9999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,4})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          healthcareInsuranceActType:
                            description: Indicates what type of Health Care Insurance Act (Zvw) is applicable for this employment
                            format: metadata
                            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
                          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
                          nominalPremium:
                            description: A nominal premium (nominale premie) for the Healthcare Insurance Act may be registered here, if applicable.
                            example: 320
                            format: double
                            maximum: 9999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,4})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          startDate:
                            description: |-
                              The start date of the entity.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 Healthcare Insurance Act record
      tags:
        - Healthcare Insurance Act
    put:
      description: |
        __Activity name:__ PutHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId

        Edit the details for a Healthcare Insurance Act record

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.
      operationId: PutHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId
      parameters:
        - description: The unique identifier of the Healthcare Insurance Act record
          in: path
          name: healthcareInsuranceActConfigurationId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              nullable: false
              properties:
                additionalContributionEmployer:
                  description: If applicable, please enter any additional contribution (extra bijdrage werkgever) for the employer in relation to the Healthcare Insurance Act (Zorgverzekeringswet).
                  example: 320
                  format: double
                  maximum: 9999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,4})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                additionalPremium:
                  description: Additional premium (aanvullende premie) on top of the nomial premium may be registered here, if applicable.
                  example: 120
                  format: double
                  maximum: 9999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,4})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: true
                  type: string
                healthcareInsuranceActType:
                  description: Indicates what type of Health Care Insurance Act (Zvw) is applicable for this employment
                  format: metadata
                  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
                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
                nominalPremium:
                  description: A nominal premium (nominale premie) for the Healthcare Insurance Act may be registered here, if applicable.
                  example: 320
                  format: double
                  maximum: 9999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,4})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                startDate:
                  description: |-
                    The start date of the entity.

                    A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
              type: object
        description: Healthcare Insurance Act record 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          additionalContributionEmployer:
                            description: If applicable, please enter any additional contribution (extra bijdrage werkgever) for the employer in relation to the Healthcare Insurance Act (Zorgverzekeringswet).
                            example: 320
                            format: double
                            maximum: 9999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,4})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          additionalPremium:
                            description: Additional premium (aanvullende premie) on top of the nomial premium may be registered here, if applicable.
                            example: 120
                            format: double
                            maximum: 9999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,4})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          healthcareInsuranceActType:
                            description: Indicates what type of Health Care Insurance Act (Zvw) is applicable for this employment
                            format: metadata
                            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
                          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
                          nominalPremium:
                            description: A nominal premium (nominale premie) for the Healthcare Insurance Act may be registered here, if applicable.
                            example: 320
                            format: double
                            maximum: 9999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,4})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          startDate:
                            description: |-
                              The start date of the entity.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2018-01-01
                            format: date
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a Healthcare Insurance Act record
      tags:
        - Healthcare Insurance Act
  "/providers/employers/employees/employments/journalallocations/{journalAllocationId}":
    delete:
      description: |
        __Activity name:__ DeleteJournalAllocationByJournalAllocationId

        Delete a journal allocation record
      operationId: DeleteJournalAllocationByJournalAllocationId
      parameters:
        - description: The unique identifier of the journal allocation
          in: path
          name: journalAllocationId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 journal allocation record
      tags:
        - Journal allocation
    get:
      description: |
        __Activity name:__ GetJournalAllocationByJournalAllocationId

        Get the details of a financial journal allocation record (journaliseren module). 
      operationId: GetJournalAllocationByJournalAllocationId
      parameters:
        - description: The unique identifier of the journal allocation
          in: path
          name: journalAllocationId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          allocationBasedOnActualHours:
                            description: |
                              Provide the allocation details within this object in case allocation based on actual hours (=normuren) is applicable. Functional effect; when PayrollPeriodData (=Variabele Gegevens) are created for this Employment, then the default values for the fields costCenter and costUnit wil be based on the settings within this resource.  So if you are an external party and want to provide costUnit and/or costCenter when sending PayrollPeriodData,  make sure you first acquire the default values by calling the `/ defaults` for the PayrollPeriodData resource (!).

                              Please note that this object MUST be null when `allocationBasedOnFixedWeights` is to be applied. Only one of the two may be provided.
                            nullable: true
                            properties:
                              costCenter:
                                description: |
                                  The applicable cost center (=kostenplaats).

                                  `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                format: metadata
                                nullable: false
                                properties:
                                  code:
                                    example: SAL073
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  description:
                                    example: Sales Den Bosch
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                type: object
                              costUnit:
                                description: |
                                  The applicable cost center (=kostendrager).
                                  `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                format: metadata
                                nullable: true
                                properties:
                                  code:
                                    example: "01"
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  description:
                                    example: Cars
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                type: object
                            type: object
                          allocationBasedOnFixedWeights:
                            description: |
                              Provide the allocation details within this object when allocation based on weights (=factor) is applicable. Functional effect; if the costCenter and/or costUnit are provided within this object than the journal run calculations will use these fixed weights when performing calculations. Any costCenters and costUnits in the PayrollPeriodData records will be ignored for the calculations in that case.

                              Please note that this object MUST be null when `allocationBasedOnActualHours` is to be applied. Only one of the two may be provided. 
                            items:
                              properties:
                                costCenter:
                                  description: |
                                    The applicable cost center (=kostenplaats).

                                    `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: false
                                  properties:
                                    code:
                                      example: SAL073
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    description:
                                      example: Sales Den Bosch
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                costUnit:
                                  description: |
                                    The applicable cost center (=kostendrager).
                                    `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    code:
                                      example: "01"
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    description:
                                      example: Cars
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                weight:
                                  description: |
                                    The weight (factor) determines the relative weight when allocating the costs for this specific combination of costCenter and costUnit.
                                  example: 1
                                  format: int32
                                  maximum: 9999
                                  minimum: 1
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            nullable: true
                            type: array
                          endPeriod:
                            format: metadata
                            nullable: true
                            properties:
                              periodEndDate:
                                description: |
                                  The last day of the payroll period.
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: |
                                  The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                example: 1
                                format: int32
                                maximum: 53
                                minimum: 1
                                nullable: false
                                readOnly: false
                                type: integer
                              periodStartDate:
                                description: |
                                  The first day of the payroll period.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: |
                                  The year of the last payroll period for which the journal allocation is applicable.
                                example: 2017
                                format: int32
                                maximum: 9999
                                minimum: 2000
                                nullable: false
                                readOnly: false
                                type: integer
                            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
                          journalProfileConfiguration:
                            description: Indicates to which journal profiel configuration the record relates
                            format: metadata
                            nullable: false
                            properties:
                              endPeriod:
                                format: metadata
                                nullable: true
                                properties:
                                  periodEndDate:
                                    description: |
                                      The last day of the payroll period.
                                    example: 2017-01-31
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  periodNumber:
                                    description: |
                                      The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                    example: 1
                                    format: int32
                                    maximum: 53
                                    minimum: 1
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  periodStartDate:
                                    description: |
                                      The first day of the payroll period.
                                    example: 2017-01-01
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  year:
                                    description: |
                                      The year of the first payroll period for which the journal allocation is applicable.
                                    example: 2017
                                    format: int32
                                    maximum: 9999
                                    minimum: 2000
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                readOnly: true
                                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: false
                                type: string
                              journalProfile:
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: General ledger supermarkets
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              startPeriod:
                                format: metadata
                                nullable: false
                                properties:
                                  periodEndDate:
                                    description: |
                                      The last day of the payroll period.
                                    example: 2017-01-31
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  periodNumber:
                                    description: |
                                      The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                    example: 1
                                    format: int32
                                    maximum: 53
                                    minimum: 1
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  periodStartDate:
                                    description: |
                                      The first day of the payroll period.
                                    example: 2017-01-01
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  year:
                                    description: |
                                      The year of the first payroll period for which the journal allocation is applicable.
                                    example: 2017
                                    format: int32
                                    maximum: 9999
                                    minimum: 2000
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                readOnly: true
                                type: object
                            readOnly: true
                            type: object
                          startPeriod:
                            format: metadata
                            nullable: false
                            properties:
                              periodEndDate:
                                description: |
                                  The last day of the payroll period.
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: |
                                  The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                example: 1
                                format: int32
                                maximum: 53
                                minimum: 1
                                nullable: false
                                readOnly: false
                                type: integer
                              periodStartDate:
                                description: |
                                  The first day of the payroll period.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: |
                                  The year of the first payroll period for which the journal allocation is applicable.
                                example: 2017
                                format: int32
                                maximum: 9999
                                minimum: 2000
                                nullable: false
                                readOnly: false
                                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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 journal allocation
      tags:
        - Journal allocation
    put:
      description: |
        __Activity name:__ PutJournalAllocationByJournalAllocationId

        Edit the details of a financial journal allocation record (journaliseren module)

        * Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.
        * Possible options dependent on a specific `startPeriod` can be acquired via `/metadata/year/{year}/period/{period}`
      operationId: PutJournalAllocationByJournalAllocationId
      parameters:
        - description: The unique identifier of the journal allocation
          in: path
          name: journalAllocationId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                allocationBasedOnActualHours:
                  description: |
                    Provide the allocation details within this object in case allocation based on actual hours (=normuren) is applicable. Functional effect; when PayrollPeriodData (=Variabele Gegevens) are created for this Employment, then the default values for the fields costCenter and costUnit wil be based on the settings within this resource.  So if you are an external party and want to provide costUnit and/or costCenter when sending PayrollPeriodData,  make sure you first acquire the default values by calling the `/ defaults` for the PayrollPeriodData resource (!).

                    Please note that this object MUST be null when `allocationBasedOnFixedWeights` is to be applied. Only one of the two may be provided.
                  nullable: true
                  properties:
                    costCenter:
                      description: |
                        The applicable cost center (=kostenplaats).

                        `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                      format: metadata
                      nullable: false
                      properties:
                        code:
                          example: SAL073
                          nullable: false
                          readOnly: true
                          type: string
                        description:
                          example: Sales Den Bosch
                          nullable: false
                          readOnly: true
                          type: string
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                      type: object
                    costUnit:
                      description: |
                        The applicable cost center (=kostendrager).
                        `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                      format: metadata
                      nullable: true
                      properties:
                        code:
                          example: "01"
                          nullable: false
                          readOnly: true
                          type: string
                        description:
                          example: Cars
                          nullable: false
                          readOnly: true
                          type: string
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                      type: object
                  type: object
                allocationBasedOnFixedWeights:
                  description: |
                    Provide the allocation details within this object when allocation based on weights (=factor) is applicable. Functional effect; if the costCenter and/or costUnit are provided within this object than the journal run calculations will use these fixed weights when performing calculations. Any costCenters and costUnits in the PayrollPeriodData records will be ignored for the calculations in that case.

                    Please note that this object MUST be null when `allocationBasedOnActualHours` is to be applied. Only one of the two may be provided. 
                  items:
                    properties:
                      costCenter:
                        description: |
                          The applicable cost center (=kostenplaats).

                          `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                        format: metadata
                        nullable: false
                        properties:
                          code:
                            example: SAL073
                            nullable: false
                            readOnly: true
                            type: string
                          description:
                            example: Sales Den Bosch
                            nullable: false
                            readOnly: true
                            type: string
                          key:
                            example: 2
                            format: int32
                            nullable: false
                            readOnly: false
                            type: integer
                        type: object
                      costUnit:
                        description: |
                          The applicable cost center (=kostendrager).
                          `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                        format: metadata
                        nullable: true
                        properties:
                          code:
                            example: "01"
                            nullable: false
                            readOnly: true
                            type: string
                          description:
                            example: Cars
                            nullable: false
                            readOnly: true
                            type: string
                          key:
                            example: 2
                            format: int32
                            nullable: false
                            readOnly: false
                            type: integer
                        type: object
                      weight:
                        description: |
                          The weight (factor) determines the relative weight when allocating the costs for this specific combination of costCenter and costUnit.
                        example: 1
                        format: int32
                        maximum: 9999
                        minimum: 1
                        nullable: false
                        readOnly: false
                        type: integer
                    type: object
                  nullable: true
                  type: array
                endPeriod:
                  format: metadata
                  nullable: true
                  properties:
                    periodEndDate:
                      description: |
                        The last day of the payroll period.
                      example: 2018-01-31
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    periodNumber:
                      description: |
                        The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                      example: 1
                      format: int32
                      maximum: 53
                      minimum: 1
                      nullable: false
                      readOnly: false
                      type: integer
                    periodStartDate:
                      description: |
                        The first day of the payroll period.
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    year:
                      description: |
                        The year of the last payroll period for which the journal allocation is applicable.
                      example: 2017
                      format: int32
                      maximum: 9999
                      minimum: 2000
                      nullable: false
                      readOnly: false
                      type: integer
                  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
                journalProfileConfiguration:
                  description: Indicates to which journal profiel configuration the record relates
                  format: metadata
                  nullable: false
                  properties:
                    endPeriod:
                      format: metadata
                      nullable: true
                      properties:
                        periodEndDate:
                          description: |
                            The last day of the payroll period.
                          example: 2017-01-31
                          format: date
                          nullable: false
                          readOnly: true
                          type: string
                        periodNumber:
                          description: |
                            The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                          example: 1
                          format: int32
                          maximum: 53
                          minimum: 1
                          nullable: false
                          readOnly: true
                          type: integer
                        periodStartDate:
                          description: |
                            The first day of the payroll period.
                          example: 2017-01-01
                          format: date
                          nullable: false
                          readOnly: true
                          type: string
                        year:
                          description: |
                            The year of the first payroll period for which the journal allocation is applicable.
                          example: 2017
                          format: int32
                          maximum: 9999
                          minimum: 2000
                          nullable: false
                          readOnly: true
                          type: integer
                      readOnly: true
                      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: false
                      type: string
                    journalProfile:
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: General ledger supermarkets
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    startPeriod:
                      format: metadata
                      nullable: false
                      properties:
                        periodEndDate:
                          description: |
                            The last day of the payroll period.
                          example: 2017-01-31
                          format: date
                          nullable: false
                          readOnly: true
                          type: string
                        periodNumber:
                          description: |
                            The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                          example: 1
                          format: int32
                          maximum: 53
                          minimum: 1
                          nullable: false
                          readOnly: true
                          type: integer
                        periodStartDate:
                          description: |
                            The first day of the payroll period.
                          example: 2017-01-01
                          format: date
                          nullable: false
                          readOnly: true
                          type: string
                        year:
                          description: |
                            The year of the first payroll period for which the journal allocation is applicable.
                          example: 2017
                          format: int32
                          maximum: 9999
                          minimum: 2000
                          nullable: false
                          readOnly: true
                          type: integer
                      readOnly: true
                      type: object
                  readOnly: true
                  type: object
                startPeriod:
                  format: metadata
                  nullable: false
                  properties:
                    periodEndDate:
                      description: |
                        The last day of the payroll period.
                      example: 2018-01-31
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    periodNumber:
                      description: |
                        The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                      example: 1
                      format: int32
                      maximum: 53
                      minimum: 1
                      nullable: false
                      readOnly: false
                      type: integer
                    periodStartDate:
                      description: |
                        The first day of the payroll period.
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    year:
                      description: |
                        The year of the first payroll period for which the journal allocation is applicable.
                      example: 2017
                      format: int32
                      maximum: 9999
                      minimum: 2000
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
        description: Organizational entity 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          allocationBasedOnActualHours:
                            description: |
                              Provide the allocation details within this object in case allocation based on actual hours (=normuren) is applicable. Functional effect; when PayrollPeriodData (=Variabele Gegevens) are created for this Employment, then the default values for the fields costCenter and costUnit wil be based on the settings within this resource.  So if you are an external party and want to provide costUnit and/or costCenter when sending PayrollPeriodData,  make sure you first acquire the default values by calling the `/ defaults` for the PayrollPeriodData resource (!).

                              Please note that this object MUST be null when `allocationBasedOnFixedWeights` is to be applied. Only one of the two may be provided.
                            nullable: true
                            properties:
                              costCenter:
                                description: |
                                  The applicable cost center (=kostenplaats).

                                  `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                format: metadata
                                nullable: false
                                properties:
                                  code:
                                    example: SAL073
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  description:
                                    example: Sales Den Bosch
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                type: object
                              costUnit:
                                description: |
                                  The applicable cost center (=kostendrager).
                                  `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                format: metadata
                                nullable: true
                                properties:
                                  code:
                                    example: "01"
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  description:
                                    example: Cars
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                type: object
                            type: object
                          allocationBasedOnFixedWeights:
                            description: |
                              Provide the allocation details within this object when allocation based on weights (=factor) is applicable. Functional effect; if the costCenter and/or costUnit are provided within this object than the journal run calculations will use these fixed weights when performing calculations. Any costCenters and costUnits in the PayrollPeriodData records will be ignored for the calculations in that case.

                              Please note that this object MUST be null when `allocationBasedOnActualHours` is to be applied. Only one of the two may be provided. 
                            items:
                              properties:
                                costCenter:
                                  description: |
                                    The applicable cost center (=kostenplaats).

                                    `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: false
                                  properties:
                                    code:
                                      example: SAL073
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    description:
                                      example: Sales Den Bosch
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                costUnit:
                                  description: |
                                    The applicable cost center (=kostendrager).
                                    `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    code:
                                      example: "01"
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    description:
                                      example: Cars
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                weight:
                                  description: |
                                    The weight (factor) determines the relative weight when allocating the costs for this specific combination of costCenter and costUnit.
                                  example: 1
                                  format: int32
                                  maximum: 9999
                                  minimum: 1
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            nullable: true
                            type: array
                          endPeriod:
                            format: metadata
                            nullable: true
                            properties:
                              periodEndDate:
                                description: |
                                  The last day of the payroll period.
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: |
                                  The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                example: 1
                                format: int32
                                maximum: 53
                                minimum: 1
                                nullable: false
                                readOnly: false
                                type: integer
                              periodStartDate:
                                description: |
                                  The first day of the payroll period.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: |
                                  The year of the last payroll period for which the journal allocation is applicable.
                                example: 2017
                                format: int32
                                maximum: 9999
                                minimum: 2000
                                nullable: false
                                readOnly: false
                                type: integer
                            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
                          journalProfileConfiguration:
                            description: Indicates to which journal profiel configuration the record relates
                            format: metadata
                            nullable: false
                            properties:
                              endPeriod:
                                format: metadata
                                nullable: true
                                properties:
                                  periodEndDate:
                                    description: |
                                      The last day of the payroll period.
                                    example: 2017-01-31
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  periodNumber:
                                    description: |
                                      The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                    example: 1
                                    format: int32
                                    maximum: 53
                                    minimum: 1
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  periodStartDate:
                                    description: |
                                      The first day of the payroll period.
                                    example: 2017-01-01
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  year:
                                    description: |
                                      The year of the first payroll period for which the journal allocation is applicable.
                                    example: 2017
                                    format: int32
                                    maximum: 9999
                                    minimum: 2000
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                readOnly: true
                                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: false
                                type: string
                              journalProfile:
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: General ledger supermarkets
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              startPeriod:
                                format: metadata
                                nullable: false
                                properties:
                                  periodEndDate:
                                    description: |
                                      The last day of the payroll period.
                                    example: 2017-01-31
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  periodNumber:
                                    description: |
                                      The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                    example: 1
                                    format: int32
                                    maximum: 53
                                    minimum: 1
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  periodStartDate:
                                    description: |
                                      The first day of the payroll period.
                                    example: 2017-01-01
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  year:
                                    description: |
                                      The year of the first payroll period for which the journal allocation is applicable.
                                    example: 2017
                                    format: int32
                                    maximum: 9999
                                    minimum: 2000
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                readOnly: true
                                type: object
                            readOnly: true
                            type: object
                          startPeriod:
                            format: metadata
                            nullable: false
                            properties:
                              periodEndDate:
                                description: |
                                  The last day of the payroll period.
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: |
                                  The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                example: 1
                                format: int32
                                maximum: 53
                                minimum: 1
                                nullable: false
                                readOnly: false
                                type: integer
                              periodStartDate:
                                description: |
                                  The first day of the payroll period.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: |
                                  The year of the first payroll period for which the journal allocation is applicable.
                                example: 2017
                                format: int32
                                maximum: 9999
                                minimum: 2000
                                nullable: false
                                readOnly: false
                                type: integer
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a journal allocation record
      tags:
        - Journal allocation
  "/providers/employers/employees/employments/leave/{leaveId}":
    delete:
      description: |
        __Activity name :__ DeleteLeaveByLeaveId

        Delete an existing Leave record
      operationId: DeleteLeaveByLeaveId
      parameters:
        - description: The unique identifier of the leave
          in: path
          name: leaveId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 leave record
      tags:
        - Leave
    get:
      description: |-
        __Activity name :__ GetLeaveByLeaveId

        Returns one leave entry (either addition or subtraction).
      operationId: GetLeaveByLeaveId
      parameters:
        - description: The unique identifier of the leave
          in: path
          name: leaveId
          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 <TOKEN>
            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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          comment:
                            example: some comment
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          endDate:
                            description: The end date of the leave requested (last day of the leave)
                            example: 2017-11-01
                            format: date
                            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
                          isAccrual:
                            description: |
                              Indicates whether the request is for accrual of leave.
                              - false will result in a reduction of the employee's leave entitlement
                              - true will result in an increase of the employee's leave entitlement
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          leaveType:
                            description: |-
                              The type of leave requested by the employee
                              `leaveType` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              balanceExceedsYear:
                                description: |
                                  Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                                example: true
                                nullable: false
                                readOnly: true
                                type: boolean
                              key:
                                description: |
                                  The key for the leave type.
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the leave type. Note that leave types can be overridden at the employer level. In these cases the description at the employer level takes precedence over the default description of the leave type.
                                example: Verlof (bovenwettelijk)
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          numberOfUnits:
                            description: The number of leave units requested
                            example: 8
                            format: double
                            maximum: 999.99
                            minimum: 0
                            nullable: false
                            pattern: ^(\d{1,3})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          origin:
                            nullable: false
                            properties:
                              leavePolicy:
                                description: |-
                                  The leave policy for which the record was created. Will only have a value if `meansOfCreation` indicates a leave policy

                                  `leavePolicy` is a metadata field within the employer context. Possible values can be managed by the user.
                                format: metadata
                                nullable: true
                                properties:
                                  id:
                                    description: The unique identifier (a 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
                                  leaveUnitType:
                                    description: The type of leave units either days or hours
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        description: |
                                          The key for the leave unit Type.
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: true
                                        type: integer
                                      value:
                                        description: |
                                          The description for the leave unit type
                                        example: Uren
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                  value:
                                    description: |
                                      The description of the leave regulation.
                                    example: Default leave Regulations
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              meansOfCreation:
                                description: The means of creation  of the record
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The key for the means of creation
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  value:
                                    description: |
                                      The description for the leave unit type
                                    example: individual
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                            readOnly: true
                            type: object
                          relatedLeave:
                            description: |-
                              Incase two leave records are linked to a single leave request the ID of the linked leave record is returned in this field. This is done because when deleting a leave record linked to a leave request the other leave record linked to that leave request is also deleted

                              The only functional scenario when this may occur is when a leave request is entered for leaveType 16 (Verlof). Depending on the leave balances, this might result in both a leave booking for Verlof (wettelijk) and Verlof (botenwettelijk).
                            nullable: true
                            properties:
                              id:
                                description: The unique identifier (a 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
                            readOnly: true
                            type: object
                          relatedLeaveRequest:
                            description: Incase that the leave record is the result of the approval of a leave request this value will be set to the ID of that leave request.
                            nullable: true
                            properties:
                              id:
                                description: The unique identifier (a 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
                            readOnly: true
                            type: object
                          startDate:
                            description: The start date of the leave requested
                            example: 2017-11-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          unitType:
                            description: If known indicates what the unit type (hours or days) is for `numberOfUnits`. Otherwise the field will be null.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                description: |
                                  The key for the unit type
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the unit type
                                example: Uren
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: A single leave entry
      tags:
        - Leave
    put:
      description: |
        __Activity name :__ PutLeaveByLeaveId

        Edit the details of a leave
      operationId: PutLeaveByLeaveId
      parameters:
        - description: The unique identifier of the leave
          in: path
          name: leaveId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                comment:
                  example: some comment
                  maxLength: 4000
                  nullable: true
                  readOnly: false
                  type: string
                endDate:
                  description: The end date of the leave requested (last day of the leave)
                  example: 2017-11-01
                  format: date
                  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
                isAccrual:
                  description: |
                    Indicates whether the request is for accrual of leave.
                    - false will result in a reduction of the employee's leave entitlement
                    - true will result in an increase of the employee's leave entitlement
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                leaveType:
                  description: |-
                    The type of leave requested by the employee
                    `leaveType` is a metadata field within the employer context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    balanceExceedsYear:
                      description: |
                        Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                      example: true
                      nullable: false
                      readOnly: true
                      type: boolean
                    key:
                      description: |
                        The key for the leave type.
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        The description for the leave type. Note that leave types can be overridden at the employer level. In these cases the description at the employer level takes precedence over the default description of the leave type.
                      example: Verlof (bovenwettelijk)
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                numberOfUnits:
                  description: The number of leave units requested
                  example: 8
                  format: double
                  maximum: 999.99
                  minimum: 0
                  nullable: false
                  pattern: ^(\d{1,3})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                origin:
                  nullable: false
                  properties:
                    leavePolicy:
                      description: |-
                        The leave policy for which the record was created. Will only have a value if `meansOfCreation` indicates a leave policy

                        `leavePolicy` is a metadata field within the employer context. Possible values can be managed by the user.
                      format: metadata
                      nullable: true
                      properties:
                        id:
                          description: The unique identifier (a 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
                        leaveUnitType:
                          description: The type of leave units either days or hours
                          format: metadata
                          nullable: false
                          properties:
                            key:
                              description: |
                                The key for the leave unit Type.
                              example: 1
                              format: int32
                              nullable: false
                              readOnly: true
                              type: integer
                            value:
                              description: |
                                The description for the leave unit type
                              example: Uren
                              nullable: false
                              readOnly: true
                              type: string
                          type: object
                        value:
                          description: |
                            The description of the leave regulation.
                          example: Default leave Regulations
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    meansOfCreation:
                      description: The means of creation  of the record
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          description: |
                            The key for the means of creation
                          example: 1
                          format: int32
                          nullable: false
                          readOnly: true
                          type: integer
                        value:
                          description: |
                            The description for the leave unit type
                          example: individual
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                  readOnly: true
                  type: object
                relatedLeave:
                  description: |-
                    Incase two leave records are linked to a single leave request the ID of the linked leave record is returned in this field. This is done because when deleting a leave record linked to a leave request the other leave record linked to that leave request is also deleted

                    The only functional scenario when this may occur is when a leave request is entered for leaveType 16 (Verlof). Depending on the leave balances, this might result in both a leave booking for Verlof (wettelijk) and Verlof (botenwettelijk).
                  nullable: true
                  properties:
                    id:
                      description: The unique identifier (a 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
                  readOnly: true
                  type: object
                relatedLeaveRequest:
                  description: Incase that the leave record is the result of the approval of a leave request this value will be set to the ID of that leave request.
                  nullable: true
                  properties:
                    id:
                      description: The unique identifier (a 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
                  readOnly: true
                  type: object
                startDate:
                  description: The start date of the leave requested
                  example: 2017-11-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                unitType:
                  description: If known indicates what the unit type (hours or days) is for `numberOfUnits`. Otherwise the field will be null.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      description: |
                        The key for the unit type
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        The description for the unit type
                      example: Uren
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
        description: Leave 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          comment:
                            example: some comment
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          endDate:
                            description: The end date of the leave requested (last day of the leave)
                            example: 2017-11-01
                            format: date
                            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
                          isAccrual:
                            description: |
                              Indicates whether the request is for accrual of leave.
                              - false will result in a reduction of the employee's leave entitlement
                              - true will result in an increase of the employee's leave entitlement
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          leaveType:
                            description: |-
                              The type of leave requested by the employee
                              `leaveType` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              balanceExceedsYear:
                                description: |
                                  Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                                example: true
                                nullable: false
                                readOnly: true
                                type: boolean
                              key:
                                description: |
                                  The key for the leave type.
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the leave type. Note that leave types can be overridden at the employer level. In these cases the description at the employer level takes precedence over the default description of the leave type.
                                example: Verlof (bovenwettelijk)
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          numberOfUnits:
                            description: The number of leave units requested
                            example: 8
                            format: double
                            maximum: 999.99
                            minimum: 0
                            nullable: false
                            pattern: ^(\d{1,3})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          origin:
                            nullable: false
                            properties:
                              leavePolicy:
                                description: |-
                                  The leave policy for which the record was created. Will only have a value if `meansOfCreation` indicates a leave policy

                                  `leavePolicy` is a metadata field within the employer context. Possible values can be managed by the user.
                                format: metadata
                                nullable: true
                                properties:
                                  id:
                                    description: The unique identifier (a 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
                                  leaveUnitType:
                                    description: The type of leave units either days or hours
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        description: |
                                          The key for the leave unit Type.
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: true
                                        type: integer
                                      value:
                                        description: |
                                          The description for the leave unit type
                                        example: Uren
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                  value:
                                    description: |
                                      The description of the leave regulation.
                                    example: Default leave Regulations
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              meansOfCreation:
                                description: The means of creation  of the record
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The key for the means of creation
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  value:
                                    description: |
                                      The description for the leave unit type
                                    example: individual
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                            readOnly: true
                            type: object
                          relatedLeave:
                            description: |-
                              Incase two leave records are linked to a single leave request the ID of the linked leave record is returned in this field. This is done because when deleting a leave record linked to a leave request the other leave record linked to that leave request is also deleted

                              The only functional scenario when this may occur is when a leave request is entered for leaveType 16 (Verlof). Depending on the leave balances, this might result in both a leave booking for Verlof (wettelijk) and Verlof (botenwettelijk).
                            nullable: true
                            properties:
                              id:
                                description: The unique identifier (a 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
                            readOnly: true
                            type: object
                          relatedLeaveRequest:
                            description: Incase that the leave record is the result of the approval of a leave request this value will be set to the ID of that leave request.
                            nullable: true
                            properties:
                              id:
                                description: The unique identifier (a 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
                            readOnly: true
                            type: object
                          startDate:
                            description: The start date of the leave requested
                            example: 2017-11-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          unitType:
                            description: If known indicates what the unit type (hours or days) is for `numberOfUnits`. Otherwise the field will be null.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                description: |
                                  The key for the unit type
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the unit type
                                example: Uren
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a leave
      tags:
        - Leave
  "/providers/employers/employees/employments/leave/{leaveId}/metadata":
    get:
      description: |
        __Activity name :__ GetLeaveMetadataByLeaveId

        Returns the metadata values for all the metadata fields.
      operationId: GetLeaveMetadataByLeaveId
      parameters:
        - description: The unique identifier of the leave
          in: path
          name: leaveId
          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 <TOKEN>
            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:
              examples:
                metadata:
                  value:
                    _embedded:
                      - field: leaveType
                        options:
                          - key: 1
                            value: Verlof wettelijk
                          - key: 15
                            value: Bijzonder verlof
                    currentPage: 1
                    messages: []
                    pageSize: 250
                    totalPages: 1
                    totalSize: 3
                    version:
                      obsoleteDate: null
                      resourceVersion: 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: 2018-12-31
                            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 <field>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: BrokenBusinessRule
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            field:
                              description: |
                                The field name of the metadata field
                              example: <name of the metadata field>
                              nullable: false
                              readOnly: true
                              type: string
                            options:
                              items:
                                properties:
                                  key:
                                    description: |
                                      The key for the metadata field.
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: |
                                      The description for the metadata field
                                    example: <Description>
                                    nullable: false
                                    readOnly: true
                                    type: string
                              nullable: false
                              readOnly: true
                              type: array
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the values for the metadata fields
      tags:
        - Leave
  /providers/employers/employees/employments/leaverequests:
    patch:
      description: |
        __Activity name :__ PatchLeaveRequestsByLeaveRequestIds

        This endpoints changes the status of the list of leave requests provided in the request body to the provided status. The leave requests are processed one by one. The leave requests that had no error's will be commited to the database while those with an error will be skipped. If an error occured the service will return a 400 bad request with a message explaining what error occured for what ID (GUID).  The leave requests that where processed succesfully will not be returned in te response.
      operationId: PatchLeaveRequestsByLeaveRequestIds
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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:
                  action:
                    description: |-
                      The action to perform on the leave request resulting in a change of `leaveRequestStatus`
                      The following transitions are possible
                      * leaveRequestStatus = submitted -> accept or reject
                      * leaveRequestStatus = accepted -> no changes possible
                      * leaveRequestStatus = rejected -> reopen
                      * leaveRequestStatus = revoked by user -> no changes possible
                    enum:
                      - accept
                      - reject
                      - reopen
                    nullable: false
                    readOnly: false
                    type: string
                  id:
                    description: The unique identifier (a 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: array
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the status of leave requests
      tags:
        - Leave request
  "/providers/employers/employees/employments/leaverequests/{leaveRequestId}":
    get:
      description: |
        __Activity name :__ GetLeaveRequestByLeaveRequestId

        Get the details of a single leave request
      operationId: GetLeaveRequestByLeaveRequestId
      parameters:
        - description: The unique identifier of the leave request
          in: path
          name: leaveRequestId
          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 <TOKEN>
            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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          commentEmployee:
                            description: The comment left by the employee
                            example: Vakantie naar Spanje
                            maxLength: 4000
                            nullable: true
                            readOnly: true
                            type: string
                          commentHandler:
                            description: The comment left by the person handling the leave request
                            example: Fijne vakantie!
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          currentlyAvailableUnits:
                            description: |-
                              The number of leave units (of the leaveType for this leave request) available to the employment.
                              This value can be negative.
                            example: 140
                            format: double
                            nullable: false
                            readOnly: true
                            type: number
                          endDate:
                            description: The end date of the leave requested (last day of the leave)
                            example: 2017-11-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          handledBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformated user name for displaying. <lastname>", "<initials>" "<prefix>
                                example: Jong, I
                                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 user
                                example: ABC
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          handledTime:
                            description: The date and time the leave request was handled
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            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
                          isAccrual:
                            default: false
                            description: |
                              Indicates whether the request is for accrual of leave.
                              - false will result in a reduction of the employee's leave entitlement
                              - true will result in an increase of the employee's leave entitlement
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          leaveRequestStatus:
                            description: |-
                              The current status of the leave request

                              The leave request status is changed by using the PATCH endpoint (not the PUT).

                              The following transitions are possible
                              * leaveRequestStatus = submitted -> accepted or rejected
                              * leaveRequestStatus = accepted -> no changes possible
                              * leaveRequestStatus = rejected -> submitted
                              * leaveRequestStatus = revoked by user -> no changes possible
                              * leaveRequestStatus = related leave deleted -> no changes possible
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 9
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Geaccepteerd
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          leaveType:
                            description: |-
                              The type of leave requested by the employee

                              `leaveType` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Verlof (bovenwettelijk)
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          numberOfUnits:
                            description: The number of leave units requested
                            example: 8
                            format: double
                            maximum: 999.99
                            minimum: 0.01
                            nullable: false
                            pattern: ^(\d{1,3})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          startDate:
                            description: The start date of the leave requested
                            example: 2017-11-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          submittedBy:
                            format: metadata
                            nullable: false
                            properties:
                              dateOfBirth:
                                description: |
                                  The date of birth
                                example: 1995-05-21
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              employeeNumber:
                                description: The employee number to uniquely identify a employee within a 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
                              lastNamePartner:
                                description: The last name of the partner of the employee
                                example: Wiel
                                maxLength: 25
                                nullable: true
                                readOnly: true
                                type: string
                              photo:
                                description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                format: url
                                nullable: true
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the employee
                                example: van
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                              prefixPartner:
                                description: The prefix of the partner of the employee
                                example: van de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          submittedOn:
                            description: The time the leave request was submitted
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          unitType:
                            description: If known indicates what the unit type (hours or days) is for `numberOfUnits`. Otherwise the field will be null.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                description: |
                                  The key for the unit type
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the unit type
                                example: Uren
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 leave request
      tags:
        - Leave request
    put:
      description: |
        __Activity name :__ PutLeaveRequestByLeaveRequestId
           

        Change the details of a Leave request

        __Important:__ A PUT is only allowed when the leave requests is in the status "submitted"/"ingediend". Only the field of `commentHandler`  may be editied in other statuses.
      operationId: PutLeaveRequestByLeaveRequestId
      parameters:
        - description: The unique identifier of the leave request
          in: path
          name: leaveRequestId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                commentEmployee:
                  description: The comment left by the employee
                  example: Vakantie naar Spanje
                  maxLength: 4000
                  nullable: true
                  readOnly: true
                  type: string
                commentHandler:
                  description: The comment left by the person handling the leave request
                  example: Fijne vakantie!
                  maxLength: 4000
                  nullable: true
                  readOnly: false
                  type: string
                currentlyAvailableUnits:
                  description: |-
                    The number of leave units (of the leaveType for this leave request) available to the employment.
                    This value can be negative.
                  example: 140
                  format: double
                  nullable: false
                  readOnly: true
                  type: number
                endDate:
                  description: The end date of the leave requested (last day of the leave)
                  example: 2017-11-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                handledBy:
                  format: metadata
                  nullable: true
                  properties:
                    formattedName:
                      description: preformated user name for displaying. <lastname>", "<initials>" "<prefix>
                      example: Jong, I
                      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 user
                      example: ABC
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                handledTime:
                  description: The date and time the leave request was handled
                  example: 2018-05-08T15:16:49+02:00
                  format: date-time
                  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
                isAccrual:
                  default: false
                  description: |
                    Indicates whether the request is for accrual of leave.
                    - false will result in a reduction of the employee's leave entitlement
                    - true will result in an increase of the employee's leave entitlement
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                leaveRequestStatus:
                  description: |-
                    The current status of the leave request

                    The leave request status is changed by using the PATCH endpoint (not the PUT).

                    The following transitions are possible
                    * leaveRequestStatus = submitted -> accepted or rejected
                    * leaveRequestStatus = accepted -> no changes possible
                    * leaveRequestStatus = rejected -> submitted
                    * leaveRequestStatus = revoked by user -> no changes possible
                    * leaveRequestStatus = related leave deleted -> no changes possible
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      example: 9
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Geaccepteerd
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                leaveType:
                  description: |-
                    The type of leave requested by the employee

                    `leaveType` is a metadata field within the employer context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Verlof (bovenwettelijk)
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                numberOfUnits:
                  description: The number of leave units requested
                  example: 8
                  format: double
                  maximum: 999.99
                  minimum: 0.01
                  nullable: false
                  pattern: ^(\d{1,3})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                startDate:
                  description: The start date of the leave requested
                  example: 2017-11-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                submittedBy:
                  format: metadata
                  nullable: false
                  properties:
                    dateOfBirth:
                      description: |
                        The date of birth
                      example: 1995-05-21
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    employeeNumber:
                      description: The employee number to uniquely identify a employee within a 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
                    lastNamePartner:
                      description: The last name of the partner of the employee
                      example: Wiel
                      maxLength: 25
                      nullable: true
                      readOnly: true
                      type: string
                    photo:
                      description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                      example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                      format: url
                      nullable: true
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the employee
                      example: van
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                    prefixPartner:
                      description: The prefix of the partner of the employee
                      example: van de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                submittedOn:
                  description: The time the leave request was submitted
                  example: 2018-05-08T15:16:49+02:00
                  format: date-time
                  nullable: false
                  readOnly: true
                  type: string
                unitType:
                  description: If known indicates what the unit type (hours or days) is for `numberOfUnits`. Otherwise the field will be null.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      description: |
                        The key for the unit type
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        The description for the unit type
                      example: Uren
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
        description: __Important:__ A PUT is only allowed when the leave requests is in the status "submitted"/"ingediend". Only the field of `commentHandler` may be editied in other statuses.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          commentEmployee:
                            description: The comment left by the employee
                            example: Vakantie naar Spanje
                            maxLength: 4000
                            nullable: true
                            readOnly: true
                            type: string
                          commentHandler:
                            description: The comment left by the person handling the leave request
                            example: Fijne vakantie!
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          currentlyAvailableUnits:
                            description: |-
                              The number of leave units (of the leaveType for this leave request) available to the employment.
                              This value can be negative.
                            example: 140
                            format: double
                            nullable: false
                            readOnly: true
                            type: number
                          endDate:
                            description: The end date of the leave requested (last day of the leave)
                            example: 2017-11-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          handledBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformated user name for displaying. <lastname>", "<initials>" "<prefix>
                                example: Jong, I
                                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 user
                                example: ABC
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          handledTime:
                            description: The date and time the leave request was handled
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            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
                          isAccrual:
                            default: false
                            description: |
                              Indicates whether the request is for accrual of leave.
                              - false will result in a reduction of the employee's leave entitlement
                              - true will result in an increase of the employee's leave entitlement
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          leaveRequestStatus:
                            description: |-
                              The current status of the leave request

                              The leave request status is changed by using the PATCH endpoint (not the PUT).

                              The following transitions are possible
                              * leaveRequestStatus = submitted -> accepted or rejected
                              * leaveRequestStatus = accepted -> no changes possible
                              * leaveRequestStatus = rejected -> submitted
                              * leaveRequestStatus = revoked by user -> no changes possible
                              * leaveRequestStatus = related leave deleted -> no changes possible
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 9
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Geaccepteerd
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          leaveType:
                            description: |-
                              The type of leave requested by the employee

                              `leaveType` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Verlof (bovenwettelijk)
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          numberOfUnits:
                            description: The number of leave units requested
                            example: 8
                            format: double
                            maximum: 999.99
                            minimum: 0.01
                            nullable: false
                            pattern: ^(\d{1,3})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          startDate:
                            description: The start date of the leave requested
                            example: 2017-11-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          submittedBy:
                            format: metadata
                            nullable: false
                            properties:
                              dateOfBirth:
                                description: |
                                  The date of birth
                                example: 1995-05-21
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              employeeNumber:
                                description: The employee number to uniquely identify a employee within a 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
                              lastNamePartner:
                                description: The last name of the partner of the employee
                                example: Wiel
                                maxLength: 25
                                nullable: true
                                readOnly: true
                                type: string
                              photo:
                                description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                format: url
                                nullable: true
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the employee
                                example: van
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                              prefixPartner:
                                description: The prefix of the partner of the employee
                                example: van de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          submittedOn:
                            description: The time the leave request was submitted
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          unitType:
                            description: If known indicates what the unit type (hours or days) is for `numberOfUnits`. Otherwise the field will be null.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                description: |
                                  The key for the unit type
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the unit type
                                example: Uren
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Change the details of a leave request
      tags:
        - Leave request
  "/providers/employers/employees/employments/notes/{noteId}":
    delete:
      description: |
        __Activity name :__ DeleteEmploymentNoteByNoteId

        Delete an existing note record
      operationId: DeleteEmploymentNoteByNoteId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: noteId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employment note record
      tags:
        - Employment notes
    get:
      description: |
        __Activity name :__ GetEmploymentNoteByNoteId

        Get the details of an employment note
      operationId: GetEmploymentNoteByNoteId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: noteId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            accessibleBy:
                              description: |
                                Indicates who can view this node.
                              nullable: false
                              properties:
                                key:
                                  description: The key for accessible by
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: Description of the accessible by
                                  example: Everyone
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            createdBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            createdOn:
                              description: |
                                The date on which the note was created
                              example: 2018-01-01
                              format: date-time
                              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
                            lastModifiedBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            lastModifiedOn:
                              description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                              example: 2018-01-01
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            note:
                              description: |-
                                The note it self.

                                __Note:__ This is a free text field so users can add htlm/script etc.
                              example: Remember to do xyz
                              maxLength: 4000
                              nullable: true
                              readOnly: false
                              type: string
                            subject:
                              description: subject of the note
                              example: Remember to do xyz
                              maxLength: 250
                              nullable: false
                              readOnly: false
                              type: string
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employment note
      tags:
        - Employment notes
    put:
      description: |
        __Activity name :__ PutEmploymentNoteByNoteId

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.
      operationId: PutEmploymentNoteByNoteId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: noteId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                accessibleBy:
                  description: |
                    Indicates who can view this node.
                  nullable: false
                  properties:
                    key:
                      description: The key for accessible by
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: Description of the accessible by
                      example: Everyone
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                createdBy:
                  format: metadata
                  nullable: true
                  properties:
                    formattedName:
                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                createdOn:
                  description: |
                    The date on which the note was created
                  example: 2018-01-01
                  format: date-time
                  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
                lastModifiedBy:
                  format: metadata
                  nullable: true
                  properties:
                    formattedName:
                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                lastModifiedOn:
                  description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                  example: 2018-01-01
                  format: date-time
                  nullable: false
                  readOnly: true
                  type: string
                note:
                  description: |-
                    The note it self.

                    __Note:__ This is a free text field so users can add htlm/script etc.
                  example: Remember to do xyz
                  maxLength: 4000
                  nullable: true
                  readOnly: false
                  type: string
                subject:
                  description: subject of the note
                  example: Remember to do xyz
                  maxLength: 250
                  nullable: false
                  readOnly: false
                  type: string
              type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          accessibleBy:
                            description: |
                              Indicates who can view this node.
                            nullable: false
                            properties:
                              key:
                                description: The key for accessible by
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: Description of the accessible by
                                example: Everyone
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          createdBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          createdOn:
                            description: |
                              The date on which the note was created
                            example: 2018-01-01
                            format: date-time
                            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
                          lastModifiedBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          lastModifiedOn:
                            description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                            example: 2018-01-01
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          note:
                            description: |-
                              The note it self.

                              __Note:__ This is a free text field so users can add htlm/script etc.
                            example: Remember to do xyz
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          subject:
                            description: subject of the note
                            example: Remember to do xyz
                            maxLength: 250
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit an employment note record
      tags:
        - Employment notes
  "/providers/employers/employees/employments/organizationalentities/{organizationalEntityId}":
    delete:
      description: |
        __Activity name:__ DeleteOrganizationalEntityByOrganizationalEntityId

        Delete a organizational entity for the employment
      operationId: DeleteOrganizationalEntityByOrganizationalEntityId
      parameters:
        - description: The unique identifier of the organizational entity
          in: path
          name: organizationalEntityId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 organizational entity record
      tags:
        - Organizational entity
    get:
      description: |
        __Activity name:__ GetOrganizationalEntityByOrganizationalEntityId

        Get the details of organizational entity
      operationId: GetOrganizationalEntityByOrganizationalEntityId
      parameters:
        - description: The unique identifier of the organizational entity
          in: path
          name: organizationalEntityId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          department:
                            description: |-
                              The department of the employment.

                              `department` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              code:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              description:
                                example: Verkoop
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                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
                            type: object
                          deviatingFunctionDescription:
                            description: The deviating function description of the employment. This description deviates from the value of the `function` field.
                            example: Directeur
                            maxLength: 50
                            nullable: true
                            readOnly: false
                            type: string
                          deviatingFunctionGroup:
                            description: The deviating function group description of the employment. Only applies when a deviating function description is defined.
                            example: 9A
                            maxLength: 5
                            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.

                              `distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              code:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              description:
                                example: Sales
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                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
                            type: object
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          function:
                            description: |-
                              The function of the employment.

                              `function` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Directeur
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                              group:
                                example: internal
                                maxLength: 5
                                nullable: true
                                readOnly: true
                                type: string
                              key:
                                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
                            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
                          internalTelephoneExtensionNumber:
                            description: The phone number of the standard working location (standplaats) for the employment.
                            example: "678"
                            maxLength: 15
                            nullable: true
                            readOnly: false
                            type: string
                          placeOfEmployment:
                            description: The standard working location (standplaats) for the employment.
                            example: Amsterdam office
                            maxLength: 24
                            nullable: true
                            readOnly: false
                            type: string
                          standardFunction:
                            description: |-
                              The standard (cao)function of the employment.

                              `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
                          startDate:
                            description: |-
                              The start date of the entity.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 organizational entity
      tags:
        - Organizational entity
    put:
      description: |
        __Activity name:__ PutOrganizationalEntityByOrganizationalEntityId

        Edit the details for an organizational entity

        Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.
      operationId: PutOrganizationalEntityByOrganizationalEntityId
      parameters:
        - description: The unique identifier of the organizational entity
          in: path
          name: organizationalEntityId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                department:
                  description: |-
                    The department of the employment.

                    `department` is a metadata field within the employer context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    code:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    description:
                      example: Verkoop
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      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
                  type: object
                deviatingFunctionDescription:
                  description: The deviating function description of the employment. This description deviates from the value of the `function` field.
                  example: Directeur
                  maxLength: 50
                  nullable: true
                  readOnly: false
                  type: string
                deviatingFunctionGroup:
                  description: The deviating function group description of the employment. Only applies when a deviating function description is defined.
                  example: 9A
                  maxLength: 5
                  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.

                    `distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    code:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    description:
                      example: Sales
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      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
                  type: object
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: true
                  type: string
                function:
                  description: |-
                    The function of the employment.

                    `function` is a metadata field within the employer context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    description:
                      example: Directeur
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                    group:
                      example: internal
                      maxLength: 5
                      nullable: true
                      readOnly: true
                      type: string
                    key:
                      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
                  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
                internalTelephoneExtensionNumber:
                  description: The phone number of the standard working location (standplaats) for the employment.
                  example: "678"
                  maxLength: 15
                  nullable: true
                  readOnly: false
                  type: string
                placeOfEmployment:
                  description: The standard working location (standplaats) for the employment.
                  example: Amsterdam office
                  maxLength: 24
                  nullable: true
                  readOnly: false
                  type: string
                standardFunction:
                  description: |-
                    The standard (cao)function of the employment.

                    `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
                startDate:
                  description: |-
                    The start date of the entity.

                    A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
        description: Organizational entity 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          department:
                            description: |-
                              The department of the employment.

                              `department` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              code:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              description:
                                example: Verkoop
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                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
                            type: object
                          deviatingFunctionDescription:
                            description: The deviating function description of the employment. This description deviates from the value of the `function` field.
                            example: Directeur
                            maxLength: 50
                            nullable: true
                            readOnly: false
                            type: string
                          deviatingFunctionGroup:
                            description: The deviating function group description of the employment. Only applies when a deviating function description is defined.
                            example: 9A
                            maxLength: 5
                            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.

                              `distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              code:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              description:
                                example: Sales
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                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
                            type: object
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          function:
                            description: |-
                              The function of the employment.

                              `function` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Directeur
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                              group:
                                example: internal
                                maxLength: 5
                                nullable: true
                                readOnly: true
                                type: string
                              key:
                                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
                            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
                          internalTelephoneExtensionNumber:
                            description: The phone number of the standard working location (standplaats) for the employment.
                            example: "678"
                            maxLength: 15
                            nullable: true
                            readOnly: false
                            type: string
                          placeOfEmployment:
                            description: The standard working location (standplaats) for the employment.
                            example: Amsterdam office
                            maxLength: 24
                            nullable: true
                            readOnly: false
                            type: string
                          standardFunction:
                            description: |-
                              The standard (cao)function of the employment.

                              `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
                          startDate:
                            description: |-
                              The start date of the entity.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2018-01-01
                            format: date
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of an organizational entity
      tags:
        - Organizational entity
  "/providers/employers/employees/employments/otherPayrollVariables/{otherPayrollVariablesId}":
    delete:
      description: |
        __Activity name :__ DeleteOtherPayrollVariablesByOtherPayrollVariablesId

        Delete an existing other payroll variables record (for an employment)
      operationId: DeleteOtherPayrollVariablesByOtherPayrollVariablesId
      parameters:
        - description: The unique identifier of the other payroll variables record
          in: path
          name: otherPayrollVariablesId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 other payroll variables record
      tags:
        - Other payroll variables
    get:
      description: |
        __Activity name :__ GetOtherPayrollVariablesByOtherPayrollVariablesId

        Get the details of other payroll variables for an employment
      operationId: GetOtherPayrollVariablesByOtherPayrollVariablesId
      parameters:
        - description: The unique identifier of the other payroll variables record
          in: path
          name: otherPayrollVariablesId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              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
                            insuranceProperties:
                              properties:
                                applicableForNoRiskPolicy:
                                  description: |-
                                    Indicates if the employment is applicable for the "Looncompensatie bij ziekte (no-riskpolis)" as defined by the UWV.

                                    Please check with the UWV to determine when to set the value to true.
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                              type: object
                            payrollProperties:
                              properties:
                                applyMinimumWageVocationalLearningPathway:
                                  description: Minimum wage vocational learning pathway (Minimumloon BBL) <to do>
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                applyYearlyHoursNorm:
                                  description: applyYearlyHoursNorm (jaarurennorm) indicates if the contract is based on a set numbers of hours per year and a set wage is payed every payroll period.
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                collectiveLaborAgreementCodeHiringEmployer:
                                  description: |-
                                    "CAO code inlener" The CAO code to be used in the payrolltax taxreturn for an employment that is "hired through agents" / " hired through an intermediary/third party".
                                    For more information when to set this value please check "Gegevensspecificaties aangifte loonheffingen 2020 v2.0 11 juli 2019"
                                  format: metadata
                                  nullable: true
                                  properties:
                                    endDate:
                                      description: The end date of the CAO
                                      example: 2018-10-23
                                      format: date
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    key:
                                      example: 151
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    startDate:
                                      description: The start date of the CAO
                                      example: 2018-01-01
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    value:
                                      example: TUINBOUWVEILINGEN
                                      maxLength: 90
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                deviatingPremiumGroup:
                                  description: Deviating premium group (Afwijkende premiegroep sectorfonds), indicates what deviating premie sector funds applies to 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: (1) Agrarisch bedrijf kort
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                incidentalIncomeDeduction:
                                  description: |-
                                    Incidental income deduction (Incidentele inkomstenvermindering) <to do>

                                    Indien gebruik gemaakt wordt van onbetaald verlof en/of ziekte uren dan wordt automatisch de code incidentele inkomstenvermindering in de loonaangifte bepaald (rubriek in de loonaangifte welke aangeeft dat het loon door ziekte of onbetaald verlof tijdelijk lager is dan het overeengekomen loon). In overige gevallen kan loket.nl niet automatisch bepalen of er sprake is van een incidentele inkomstenvermindering.  In deze rubriek dient dan de juiste waarde ingevuld te worden
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Bevalling of zwangerschap
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                occupationalDisabilityDeductionAfter2009:
                                  description: |-
                                    (OccupationalDisability) Deduction after 2009 (Arbeidsgeh.krt na 2009 (tm 2009 WAO)) <to do>
                                    Tot en met 2009 moest de premiekorting arbeidsgehandicapte werknemers gesplitst worden in een gedeelte voor de premie WAO/WIA en een gedeelte voor de premie WW-awf of UFO premie. Vanaf 2010 hoeft u het totaalbedrag niet meer te splitsen. Loket.nl zal de bedragen die opgegeven zijn bij Arbeidsgeh.krt na 2009 (tm 2009 WAO) en Arbeidsgeh. krt (tm 2009 AWF/UFO) bij elkaar optellen. U kunt vanaf 2010 dus volstaan met het vullen van Arbeidsgeh.krt na 2009 (tm 2009 WAO). Vanaf 2013 mag dit veld geen waarde meer bevatten, premiekorting arbeidsgehandicapte werknemer wordt automatisch bepaald op basis van opgegeven indicatie bij veld premiekorting
                                  example: 1
                                  format: double
                                  maximum: 9999.99
                                  minimum: 0.01
                                  nullable: true
                                  readOnly: false
                                  type: number
                                occupationalDisabilityDeductionTo2009:
                                  description: |-
                                    (OccupationalDisability) Deduction to 2009 (including 2009) (Arbeidsgeh.krt (tm 2009 AWF/UFO))
                                    Tot en met 2009 moest de premiekorting arbeidsgehandicapte werknemers gesplitst worden in een gedeelte voor de premie WAO/WIA en een gedeelte voor de premie WW-awf of UFO premie. Vanaf 2010 hoeft u het totaalbedrag niet meer te splitsen. Loket.nl zal de bedragen die opgegeven zijn bij Arbeidsgeh.krt na 2009 (tm 2009 WAO) en Arbeidsgeh. krt (tm 2009 AWF/UFO) bij elkaar optellen. U kunt vanaf 2010 dus volstaan met het vullen van Arbeidsgeh.krt na 2009 (tm 2009 WAO). Vanaf 2013 mag dit veld geen waarde meer bevatten, premiekorting arbeidsgehandicapte werknemer wordt automatisch bepaald op basis van opgegeven indicatie bij veld premiekorting
                                  example: 1
                                  format: double
                                  maximum: 9999.99
                                  minimum: 0.01
                                  nullable: true
                                  readOnly: false
                                  type: number
                                occupationalDisabilityPremiumDiscount:
                                  description: |-
                                    Occupational disability premium discount (arbeidsgehandicaptenkorting) not to be used after 2017. It indicates if "arbeidsgehandicaptenkorting" is applicable to this employment.

                                    Indicatie die aangeeft of er arbeidsgehandicaptenkorting of korting in dienst nemen van ouderen werknemer van toepassing is. Loket.nl zal bij invulling automatisch de juiste kortingen berekenen. Vanaf 2013 zijn alleen nog de codes 5 en 6 van toepassing. Indien codes 1 t/m 4 zijn ingevuld in 2013 dan interpreteert loket.nl als code 5.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: (7) Werknemer van 62, 63 of 64 jaar voor wie code 6 niet van toepassing is
                                      maxLength: 80
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                phaseClassification:
                                  description: |-
                                    Phase classification (Fase indeling) <to do>

                                    Indicatie die aangeeft in welke fase de inkomstenverhouding voor bepaalde tijd zich bevindt in het kader van de Wet Flexibiliteit en Zekerheid.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: (38) Fase A zonder uitzendbeding met uitsluiting van ldv
                                      maxLength: 60
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                terminateIncomenumberFlexibleEmployment:
                                  description: Terminate incomenumber flexible employment (Einde inkomstenverh.Flexwerker) <to do>
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: (1) Einde werk/contract, geen werk aangeboden
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                wageCostBenefit:
                                  description: |-
                                    Wage cost benefit (loonkostenvoordeel (LKV)). If applicable select the correct option to reduces the costs for an employer to employ the employee. 

                                    __UWV:__ Het loonkostenvoordeel (LKV) is een onderdeel van de Wet tegemoetkomingen loondomein (Wtl). Het LKV is een tegemoetkoming voor werkgevers die 1 of meer oudere werknemers en/of werknemers met een arbeidsbeperking in dienst nemen of houden.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: LKV herplaatsen arbeidsgehandicapte werknemer
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                wajongWithWageDispensation:
                                  description: wajongWithDispensation  (Wajong met loondispensatie (was Doelgroep banenafspraak)) indicates that the employer has the express premission to lower the wage of this employment (even below minimum wage). This indicator will disable the validation on minimum wage for this employment.
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                              type: object
                            pensionProperties:
                              properties:
                                annualCalculationBaseAbp:
                                  description: annualCalculationBase (jaargrondslag voor ABP) for ABP <to do>
                                  example: 1.5
                                  format: double
                                  maximum: 999999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,6})(\.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                applyDispensationRiskFund:
                                  description: applyDispensationRiskFund (Disp. risicofonds) <to do>
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                compulsoryEducationDays:
                                  description: compulsoryEducationDays (Aantal dagen leerplicht) <to do>
                                  example: 2
                                  format: int32
                                  maximum: 2
                                  minimum: 1
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                deviatingDisabilityInsuranceActPercentageForCordares:
                                  description: deviatingDisabilityInsuranceActPercentageForCordares (WAO % Cordares) used for Cordares. <to do>
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: 15- 25 %
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                leaveAbp:
                                  description: If both `leaveType` and `valueOfParticipationDuringLeave` are empty this parent object will be set to null. The same holds true when puting or posting this object. set `leaveAbp` to null when both `leaveType` and `valueOfParticipationDuringLeave` don't have a value
                                  nullable: true
                                  properties:
                                    leaveType:
                                      description: Leave type (Verlofsoort ABP) for ABP. <to do>
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          example: 2
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                        value:
                                          example: Politiek verlof
                                          maxLength: 50
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      type: object
                                    valueOfParticipationDuringLeave:
                                      description: valueOfParticipation (waardeDeelnemerschap) (pensioen opbouw voor ambtenaren ABP)
                                      example: 1
                                      format: int32
                                      maximum: 100
                                      minimum: 1
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                occupationalPensionFund:
                                  description: Occupational Pension Fund (BPF-code) <to do>
                                  example: 2
                                  format: int32
                                  maximum: 99
                                  minimum: 1
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                specificationOfIncomeRelationshipApg:
                                  description: specificationOfIncomeRelationship (APGVerbijzonderingInkomstenverhouding) used for the APG pension fund. <to do>
                                  format: metadata
                                  nullable: true
                                  properties:
                                    code:
                                      example: WNE
                                      maxLength: 4
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Geen bijzonderheden
                                      maxLength: 75
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                              type: object
                            productivityPercentage:
                              description: productivityPercentage (Productiviteitspercentage) can be used to indicate the productivity percentage of an employment.
                              example: 100
                              format: double
                              maximum: 100
                              minimum: 0
                              nullable: false
                              pattern: ^(\d{1,3})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            startDate:
                              description: |-
                                The date on which this record starts.

                                A (broken chain)[./#section/Data/Date-chains] is maintained with this record.
                              example: 2018-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 other payroll variables for an employment
      tags:
        - Other payroll variables
    put:
      description: |
        __Activity name :__ PutOtherPayrollVariablesByOtherPayrollVariablesId

        Change the details of an other payroll variables record

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.
      operationId: PutOtherPayrollVariablesByOtherPayrollVariablesId
      parameters:
        - description: The unique identifier of the other payroll variables record
          in: path
          name: otherPayrollVariablesId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  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
                insuranceProperties:
                  properties:
                    applicableForNoRiskPolicy:
                      description: |-
                        Indicates if the employment is applicable for the "Looncompensatie bij ziekte (no-riskpolis)" as defined by the UWV.

                        Please check with the UWV to determine when to set the value to true.
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                  type: object
                payrollProperties:
                  properties:
                    applyMinimumWageVocationalLearningPathway:
                      description: Minimum wage vocational learning pathway (Minimumloon BBL) <to do>
                      nullable: false
                      readOnly: false
                      type: boolean
                    applyYearlyHoursNorm:
                      description: applyYearlyHoursNorm (jaarurennorm) indicates if the contract is based on a set numbers of hours per year and a set wage is payed every payroll period.
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                    collectiveLaborAgreementCodeHiringEmployer:
                      description: |-
                        "CAO code inlener" The CAO code to be used in the payrolltax taxreturn for an employment that is "hired through agents" / " hired through an intermediary/third party".
                        For more information when to set this value please check "Gegevensspecificaties aangifte loonheffingen 2020 v2.0 11 juli 2019"
                      format: metadata
                      nullable: true
                      properties:
                        endDate:
                          description: The end date of the CAO
                          example: 2018-10-23
                          format: date
                          nullable: true
                          readOnly: true
                          type: string
                        key:
                          example: 151
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        startDate:
                          description: The start date of the CAO
                          example: 2018-01-01
                          format: date
                          nullable: false
                          readOnly: true
                          type: string
                        value:
                          example: TUINBOUWVEILINGEN
                          maxLength: 90
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    deviatingPremiumGroup:
                      description: Deviating premium group (Afwijkende premiegroep sectorfonds), indicates what deviating premie sector funds applies to 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: (1) Agrarisch bedrijf kort
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    incidentalIncomeDeduction:
                      description: |-
                        Incidental income deduction (Incidentele inkomstenvermindering) <to do>

                        Indien gebruik gemaakt wordt van onbetaald verlof en/of ziekte uren dan wordt automatisch de code incidentele inkomstenvermindering in de loonaangifte bepaald (rubriek in de loonaangifte welke aangeeft dat het loon door ziekte of onbetaald verlof tijdelijk lager is dan het overeengekomen loon). In overige gevallen kan loket.nl niet automatisch bepalen of er sprake is van een incidentele inkomstenvermindering.  In deze rubriek dient dan de juiste waarde ingevuld te worden
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: Bevalling of zwangerschap
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    occupationalDisabilityDeductionAfter2009:
                      description: |-
                        (OccupationalDisability) Deduction after 2009 (Arbeidsgeh.krt na 2009 (tm 2009 WAO)) <to do>
                        Tot en met 2009 moest de premiekorting arbeidsgehandicapte werknemers gesplitst worden in een gedeelte voor de premie WAO/WIA en een gedeelte voor de premie WW-awf of UFO premie. Vanaf 2010 hoeft u het totaalbedrag niet meer te splitsen. Loket.nl zal de bedragen die opgegeven zijn bij Arbeidsgeh.krt na 2009 (tm 2009 WAO) en Arbeidsgeh. krt (tm 2009 AWF/UFO) bij elkaar optellen. U kunt vanaf 2010 dus volstaan met het vullen van Arbeidsgeh.krt na 2009 (tm 2009 WAO). Vanaf 2013 mag dit veld geen waarde meer bevatten, premiekorting arbeidsgehandicapte werknemer wordt automatisch bepaald op basis van opgegeven indicatie bij veld premiekorting
                      example: 1
                      format: double
                      maximum: 9999.99
                      minimum: 0.01
                      nullable: true
                      readOnly: false
                      type: number
                    occupationalDisabilityDeductionTo2009:
                      description: |-
                        (OccupationalDisability) Deduction to 2009 (including 2009) (Arbeidsgeh.krt (tm 2009 AWF/UFO))
                        Tot en met 2009 moest de premiekorting arbeidsgehandicapte werknemers gesplitst worden in een gedeelte voor de premie WAO/WIA en een gedeelte voor de premie WW-awf of UFO premie. Vanaf 2010 hoeft u het totaalbedrag niet meer te splitsen. Loket.nl zal de bedragen die opgegeven zijn bij Arbeidsgeh.krt na 2009 (tm 2009 WAO) en Arbeidsgeh. krt (tm 2009 AWF/UFO) bij elkaar optellen. U kunt vanaf 2010 dus volstaan met het vullen van Arbeidsgeh.krt na 2009 (tm 2009 WAO). Vanaf 2013 mag dit veld geen waarde meer bevatten, premiekorting arbeidsgehandicapte werknemer wordt automatisch bepaald op basis van opgegeven indicatie bij veld premiekorting
                      example: 1
                      format: double
                      maximum: 9999.99
                      minimum: 0.01
                      nullable: true
                      readOnly: false
                      type: number
                    occupationalDisabilityPremiumDiscount:
                      description: |-
                        Occupational disability premium discount (arbeidsgehandicaptenkorting) not to be used after 2017. It indicates if "arbeidsgehandicaptenkorting" is applicable to this employment.

                        Indicatie die aangeeft of er arbeidsgehandicaptenkorting of korting in dienst nemen van ouderen werknemer van toepassing is. Loket.nl zal bij invulling automatisch de juiste kortingen berekenen. Vanaf 2013 zijn alleen nog de codes 5 en 6 van toepassing. Indien codes 1 t/m 4 zijn ingevuld in 2013 dan interpreteert loket.nl als code 5.
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: (7) Werknemer van 62, 63 of 64 jaar voor wie code 6 niet van toepassing is
                          maxLength: 80
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    phaseClassification:
                      description: |-
                        Phase classification (Fase indeling) <to do>

                        Indicatie die aangeeft in welke fase de inkomstenverhouding voor bepaalde tijd zich bevindt in het kader van de Wet Flexibiliteit en Zekerheid.
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: (38) Fase A zonder uitzendbeding met uitsluiting van ldv
                          maxLength: 60
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    terminateIncomenumberFlexibleEmployment:
                      description: Terminate incomenumber flexible employment (Einde inkomstenverh.Flexwerker) <to do>
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: (1) Einde werk/contract, geen werk aangeboden
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    wageCostBenefit:
                      description: |-
                        Wage cost benefit (loonkostenvoordeel (LKV)). If applicable select the correct option to reduces the costs for an employer to employ the employee. 

                        __UWV:__ Het loonkostenvoordeel (LKV) is een onderdeel van de Wet tegemoetkomingen loondomein (Wtl). Het LKV is een tegemoetkoming voor werkgevers die 1 of meer oudere werknemers en/of werknemers met een arbeidsbeperking in dienst nemen of houden.
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: LKV herplaatsen arbeidsgehandicapte werknemer
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    wajongWithWageDispensation:
                      description: wajongWithDispensation  (Wajong met loondispensatie (was Doelgroep banenafspraak)) indicates that the employer has the express premission to lower the wage of this employment (even below minimum wage). This indicator will disable the validation on minimum wage for this employment.
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                  type: object
                pensionProperties:
                  properties:
                    annualCalculationBaseAbp:
                      description: annualCalculationBase (jaargrondslag voor ABP) for ABP <to do>
                      example: 1.5
                      format: double
                      maximum: 999999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,6})(\.\d{1,2})?$
                      readOnly: false
                      type: number
                    applyDispensationRiskFund:
                      description: applyDispensationRiskFund (Disp. risicofonds) <to do>
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                    compulsoryEducationDays:
                      description: compulsoryEducationDays (Aantal dagen leerplicht) <to do>
                      example: 2
                      format: int32
                      maximum: 2
                      minimum: 1
                      nullable: true
                      readOnly: false
                      type: integer
                    deviatingDisabilityInsuranceActPercentageForCordares:
                      description: deviatingDisabilityInsuranceActPercentageForCordares (WAO % Cordares) used for Cordares. <to do>
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: 15- 25 %
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    leaveAbp:
                      description: If both `leaveType` and `valueOfParticipationDuringLeave` are empty this parent object will be set to null. The same holds true when puting or posting this object. set `leaveAbp` to null when both `leaveType` and `valueOfParticipationDuringLeave` don't have a value
                      nullable: true
                      properties:
                        leaveType:
                          description: Leave type (Verlofsoort ABP) for ABP. <to do>
                          format: metadata
                          nullable: false
                          properties:
                            key:
                              example: 2
                              format: int32
                              nullable: false
                              readOnly: false
                              type: integer
                            value:
                              example: Politiek verlof
                              maxLength: 50
                              nullable: false
                              readOnly: true
                              type: string
                          type: object
                        valueOfParticipationDuringLeave:
                          description: valueOfParticipation (waardeDeelnemerschap) (pensioen opbouw voor ambtenaren ABP)
                          example: 1
                          format: int32
                          maximum: 100
                          minimum: 1
                          nullable: false
                          readOnly: false
                          type: integer
                      type: object
                    occupationalPensionFund:
                      description: Occupational Pension Fund (BPF-code) <to do>
                      example: 2
                      format: int32
                      maximum: 99
                      minimum: 1
                      nullable: true
                      readOnly: false
                      type: integer
                    specificationOfIncomeRelationshipApg:
                      description: specificationOfIncomeRelationship (APGVerbijzonderingInkomstenverhouding) used for the APG pension fund. <to do>
                      format: metadata
                      nullable: true
                      properties:
                        code:
                          example: WNE
                          maxLength: 4
                          nullable: false
                          readOnly: true
                          type: string
                        key:
                          example: 1
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: Geen bijzonderheden
                          maxLength: 75
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                  type: object
                productivityPercentage:
                  description: productivityPercentage (Productiviteitspercentage) can be used to indicate the productivity percentage of an employment.
                  example: 100
                  format: double
                  maximum: 100
                  minimum: 0
                  nullable: false
                  pattern: ^(\d{1,3})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                startDate:
                  description: |-
                    The date on which this record starts.

                    A (broken chain)[./#section/Data/Date-chains] is maintained with this record.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            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
                          insuranceProperties:
                            properties:
                              applicableForNoRiskPolicy:
                                description: |-
                                  Indicates if the employment is applicable for the "Looncompensatie bij ziekte (no-riskpolis)" as defined by the UWV.

                                  Please check with the UWV to determine when to set the value to true.
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                            type: object
                          payrollProperties:
                            properties:
                              applyMinimumWageVocationalLearningPathway:
                                description: Minimum wage vocational learning pathway (Minimumloon BBL) <to do>
                                nullable: false
                                readOnly: false
                                type: boolean
                              applyYearlyHoursNorm:
                                description: applyYearlyHoursNorm (jaarurennorm) indicates if the contract is based on a set numbers of hours per year and a set wage is payed every payroll period.
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              collectiveLaborAgreementCodeHiringEmployer:
                                description: |-
                                  "CAO code inlener" The CAO code to be used in the payrolltax taxreturn for an employment that is "hired through agents" / " hired through an intermediary/third party".
                                  For more information when to set this value please check "Gegevensspecificaties aangifte loonheffingen 2020 v2.0 11 juli 2019"
                                format: metadata
                                nullable: true
                                properties:
                                  endDate:
                                    description: The end date of the CAO
                                    example: 2018-10-23
                                    format: date
                                    nullable: true
                                    readOnly: true
                                    type: string
                                  key:
                                    example: 151
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  startDate:
                                    description: The start date of the CAO
                                    example: 2018-01-01
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  value:
                                    example: TUINBOUWVEILINGEN
                                    maxLength: 90
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              deviatingPremiumGroup:
                                description: Deviating premium group (Afwijkende premiegroep sectorfonds), indicates what deviating premie sector funds applies to 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: (1) Agrarisch bedrijf kort
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              incidentalIncomeDeduction:
                                description: |-
                                  Incidental income deduction (Incidentele inkomstenvermindering) <to do>

                                  Indien gebruik gemaakt wordt van onbetaald verlof en/of ziekte uren dan wordt automatisch de code incidentele inkomstenvermindering in de loonaangifte bepaald (rubriek in de loonaangifte welke aangeeft dat het loon door ziekte of onbetaald verlof tijdelijk lager is dan het overeengekomen loon). In overige gevallen kan loket.nl niet automatisch bepalen of er sprake is van een incidentele inkomstenvermindering.  In deze rubriek dient dan de juiste waarde ingevuld te worden
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Bevalling of zwangerschap
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              occupationalDisabilityDeductionAfter2009:
                                description: |-
                                  (OccupationalDisability) Deduction after 2009 (Arbeidsgeh.krt na 2009 (tm 2009 WAO)) <to do>
                                  Tot en met 2009 moest de premiekorting arbeidsgehandicapte werknemers gesplitst worden in een gedeelte voor de premie WAO/WIA en een gedeelte voor de premie WW-awf of UFO premie. Vanaf 2010 hoeft u het totaalbedrag niet meer te splitsen. Loket.nl zal de bedragen die opgegeven zijn bij Arbeidsgeh.krt na 2009 (tm 2009 WAO) en Arbeidsgeh. krt (tm 2009 AWF/UFO) bij elkaar optellen. U kunt vanaf 2010 dus volstaan met het vullen van Arbeidsgeh.krt na 2009 (tm 2009 WAO). Vanaf 2013 mag dit veld geen waarde meer bevatten, premiekorting arbeidsgehandicapte werknemer wordt automatisch bepaald op basis van opgegeven indicatie bij veld premiekorting
                                example: 1
                                format: double
                                maximum: 9999.99
                                minimum: 0.01
                                nullable: true
                                readOnly: false
                                type: number
                              occupationalDisabilityDeductionTo2009:
                                description: |-
                                  (OccupationalDisability) Deduction to 2009 (including 2009) (Arbeidsgeh.krt (tm 2009 AWF/UFO))
                                  Tot en met 2009 moest de premiekorting arbeidsgehandicapte werknemers gesplitst worden in een gedeelte voor de premie WAO/WIA en een gedeelte voor de premie WW-awf of UFO premie. Vanaf 2010 hoeft u het totaalbedrag niet meer te splitsen. Loket.nl zal de bedragen die opgegeven zijn bij Arbeidsgeh.krt na 2009 (tm 2009 WAO) en Arbeidsgeh. krt (tm 2009 AWF/UFO) bij elkaar optellen. U kunt vanaf 2010 dus volstaan met het vullen van Arbeidsgeh.krt na 2009 (tm 2009 WAO). Vanaf 2013 mag dit veld geen waarde meer bevatten, premiekorting arbeidsgehandicapte werknemer wordt automatisch bepaald op basis van opgegeven indicatie bij veld premiekorting
                                example: 1
                                format: double
                                maximum: 9999.99
                                minimum: 0.01
                                nullable: true
                                readOnly: false
                                type: number
                              occupationalDisabilityPremiumDiscount:
                                description: |-
                                  Occupational disability premium discount (arbeidsgehandicaptenkorting) not to be used after 2017. It indicates if "arbeidsgehandicaptenkorting" is applicable to this employment.

                                  Indicatie die aangeeft of er arbeidsgehandicaptenkorting of korting in dienst nemen van ouderen werknemer van toepassing is. Loket.nl zal bij invulling automatisch de juiste kortingen berekenen. Vanaf 2013 zijn alleen nog de codes 5 en 6 van toepassing. Indien codes 1 t/m 4 zijn ingevuld in 2013 dan interpreteert loket.nl als code 5.
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: (7) Werknemer van 62, 63 of 64 jaar voor wie code 6 niet van toepassing is
                                    maxLength: 80
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              phaseClassification:
                                description: |-
                                  Phase classification (Fase indeling) <to do>

                                  Indicatie die aangeeft in welke fase de inkomstenverhouding voor bepaalde tijd zich bevindt in het kader van de Wet Flexibiliteit en Zekerheid.
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: (38) Fase A zonder uitzendbeding met uitsluiting van ldv
                                    maxLength: 60
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              terminateIncomenumberFlexibleEmployment:
                                description: Terminate incomenumber flexible employment (Einde inkomstenverh.Flexwerker) <to do>
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: (1) Einde werk/contract, geen werk aangeboden
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              wageCostBenefit:
                                description: |-
                                  Wage cost benefit (loonkostenvoordeel (LKV)). If applicable select the correct option to reduces the costs for an employer to employ the employee. 

                                  __UWV:__ Het loonkostenvoordeel (LKV) is een onderdeel van de Wet tegemoetkomingen loondomein (Wtl). Het LKV is een tegemoetkoming voor werkgevers die 1 of meer oudere werknemers en/of werknemers met een arbeidsbeperking in dienst nemen of houden.
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: LKV herplaatsen arbeidsgehandicapte werknemer
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              wajongWithWageDispensation:
                                description: wajongWithDispensation  (Wajong met loondispensatie (was Doelgroep banenafspraak)) indicates that the employer has the express premission to lower the wage of this employment (even below minimum wage). This indicator will disable the validation on minimum wage for this employment.
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                            type: object
                          pensionProperties:
                            properties:
                              annualCalculationBaseAbp:
                                description: annualCalculationBase (jaargrondslag voor ABP) for ABP <to do>
                                example: 1.5
                                format: double
                                maximum: 999999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,6})(\.\d{1,2})?$
                                readOnly: false
                                type: number
                              applyDispensationRiskFund:
                                description: applyDispensationRiskFund (Disp. risicofonds) <to do>
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              compulsoryEducationDays:
                                description: compulsoryEducationDays (Aantal dagen leerplicht) <to do>
                                example: 2
                                format: int32
                                maximum: 2
                                minimum: 1
                                nullable: true
                                readOnly: false
                                type: integer
                              deviatingDisabilityInsuranceActPercentageForCordares:
                                description: deviatingDisabilityInsuranceActPercentageForCordares (WAO % Cordares) used for Cordares. <to do>
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: 15- 25 %
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              leaveAbp:
                                description: If both `leaveType` and `valueOfParticipationDuringLeave` are empty this parent object will be set to null. The same holds true when puting or posting this object. set `leaveAbp` to null when both `leaveType` and `valueOfParticipationDuringLeave` don't have a value
                                nullable: true
                                properties:
                                  leaveType:
                                    description: Leave type (Verlofsoort ABP) for ABP. <to do>
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        example: 2
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        example: Politiek verlof
                                        maxLength: 50
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                  valueOfParticipationDuringLeave:
                                    description: valueOfParticipation (waardeDeelnemerschap) (pensioen opbouw voor ambtenaren ABP)
                                    example: 1
                                    format: int32
                                    maximum: 100
                                    minimum: 1
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                type: object
                              occupationalPensionFund:
                                description: Occupational Pension Fund (BPF-code) <to do>
                                example: 2
                                format: int32
                                maximum: 99
                                minimum: 1
                                nullable: true
                                readOnly: false
                                type: integer
                              specificationOfIncomeRelationshipApg:
                                description: specificationOfIncomeRelationship (APGVerbijzonderingInkomstenverhouding) used for the APG pension fund. <to do>
                                format: metadata
                                nullable: true
                                properties:
                                  code:
                                    example: WNE
                                    maxLength: 4
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  key:
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Geen bijzonderheden
                                    maxLength: 75
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                            type: object
                          productivityPercentage:
                            description: productivityPercentage (Productiviteitspercentage) can be used to indicate the productivity percentage of an employment.
                            example: 100
                            format: double
                            maximum: 100
                            minimum: 0
                            nullable: false
                            pattern: ^(\d{1,3})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          startDate:
                            description: |-
                              The date on which this record starts.

                              A (broken chain)[./#section/Data/Date-chains] is maintained with this record.
                            example: 2018-01-01
                            format: date
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Change the details of an other payroll variables record
      tags:
        - Other payroll variables
  "/providers/employers/employees/employments/paymentinformationnonsepa/{paymentInformationNonSepaId}":
    delete:
      description: |
        __Activity name :__ DeletePaymentInformationNonSepaByPaymentInformationNonSepaId

        Delete a payment information non-SEPA record (for an employment)
      operationId: DeletePaymentInformationNonSepaByPaymentInformationNonSepaId
      parameters:
        - description: The unique identifier of the SEPA payment record
          in: path
          name: paymentInformationNonSepaId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payment information non-SEPA record
      tags:
        - Payment information non-SEPA
    get:
      description: |
        __Activity name :__ GetPaymentInformationNonSepaByPaymentInformationNonSepaId

        Get the detail of a payment information non-SEPA record.
        For a specific payroll component, the record indicates to which IBAN account number it should be related for the purpose of outgoing payments. 
        This includes, but is not limited to, the payment of wages for an employment.
        For each payroll component there can only be one outgoing payment record per employment.
      operationId: GetPaymentInformationNonSepaBypaymentInformationNonSepaId
      parameters:
        - description: The unique identifier of the SEPA payment record
          in: path
          name: paymentInformationNonSepaId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          bank:
                            description: Information regarding the bank coresponding with the bank account number
                            nullable: false
                            properties:
                              address:
                                description: |
                                  Address of beneficiary bank
                                example: Via Roma 3
                                maxLength: 35
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              bankIdentifierCode:
                                description: |
                                  BIC /SWIFT code for the bank
                                example: AUDFDE21
                                maxLength: 11
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              city:
                                description: |
                                  City name of beneficiary bank
                                example: Rome
                                maxLength: 35
                                minLength: 1
                                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
                              name:
                                description: |
                                  Name of benificiary bank
                                example: Ben Hur
                                maxLength: 35
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                            type: object
                          bankAccountNumber:
                            description: |
                              The bank account number
                            example: "0403830171874018"
                            maxLength: 34
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          beneficiary:
                            description: Information regarding the beneficiary coresponding with the bank account number
                            nullable: false
                            properties:
                              address:
                                description: |
                                  Address of beneficiary
                                example: Via Roma 3
                                maxLength: 35
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              city:
                                description: |
                                  City name of beneficiary
                                example: Rome
                                maxLength: 35
                                minLength: 1
                                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
                              name:
                                description: |
                                  Name of the beneficiary
                                example: Ben Hur
                                maxLength: 35
                                minLength: 1
                                nullable: false
                                readOnly: false
                                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
                          payrollComponent:
                            description: |
                              The payroll component for which the outgoing payment records applies.
                              Each payroll component can only be used once per employment.

                              `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metaData
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The number for the payroll component
                                example: 260
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description of the payroll component
                                example: NETTOLOON
                                maxLength: 14
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the details of a payment information non-SEPA
      tags:
        - Payment information non-SEPA
    put:
      description: |
        __Activity name :__ PutPaymentInformationNonSepaByPaymentInformationNonSepaId

        Edit an existing payment information non-SEPA record (for an employment).
        For each unique payroll component there can only be one payment record per employment.

        __Metadata :__ Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the URL
      operationId: PutPaymentInformationNonSepaByPaymentInformationNonSepaId
      parameters:
        - description: The unique identifier of the SEPA payment record
          in: path
          name: paymentInformationNonSepaId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                bank:
                  description: Information regarding the bank coresponding with the bank account number
                  nullable: false
                  properties:
                    address:
                      description: |
                        Address of beneficiary bank
                      example: Via Roma 3
                      maxLength: 35
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    bankIdentifierCode:
                      description: |
                        BIC /SWIFT code for the bank
                      example: AUDFDE21
                      maxLength: 11
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    city:
                      description: |
                        City name of beneficiary bank
                      example: Rome
                      maxLength: 35
                      minLength: 1
                      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
                    name:
                      description: |
                        Name of benificiary bank
                      example: Ben Hur
                      maxLength: 35
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                  type: object
                bankAccountNumber:
                  description: |
                    The bank account number
                  example: "0403830171874018"
                  maxLength: 34
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                beneficiary:
                  description: Information regarding the beneficiary coresponding with the bank account number
                  nullable: false
                  properties:
                    address:
                      description: |
                        Address of beneficiary
                      example: Via Roma 3
                      maxLength: 35
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    city:
                      description: |
                        City name of beneficiary
                      example: Rome
                      maxLength: 35
                      minLength: 1
                      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
                    name:
                      description: |
                        Name of the beneficiary
                      example: Ben Hur
                      maxLength: 35
                      minLength: 1
                      nullable: false
                      readOnly: false
                      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
                payrollComponent:
                  description: |
                    The payroll component for which the outgoing payment records applies.
                    Each payroll component can only be used once per employment.

                    `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metaData
                  nullable: false
                  properties:
                    key:
                      description: |
                        The number for the payroll component
                      example: 260
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        The description of the payroll component
                      example: NETTOLOON
                      maxLength: 14
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          bank:
                            description: Information regarding the bank coresponding with the bank account number
                            nullable: false
                            properties:
                              address:
                                description: |
                                  Address of beneficiary bank
                                example: Via Roma 3
                                maxLength: 35
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              bankIdentifierCode:
                                description: |
                                  BIC /SWIFT code for the bank
                                example: AUDFDE21
                                maxLength: 11
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              city:
                                description: |
                                  City name of beneficiary bank
                                example: Rome
                                maxLength: 35
                                minLength: 1
                                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
                              name:
                                description: |
                                  Name of benificiary bank
                                example: Ben Hur
                                maxLength: 35
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                            type: object
                          bankAccountNumber:
                            description: |
                              The bank account number
                            example: "0403830171874018"
                            maxLength: 34
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          beneficiary:
                            description: Information regarding the beneficiary coresponding with the bank account number
                            nullable: false
                            properties:
                              address:
                                description: |
                                  Address of beneficiary
                                example: Via Roma 3
                                maxLength: 35
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              city:
                                description: |
                                  City name of beneficiary
                                example: Rome
                                maxLength: 35
                                minLength: 1
                                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
                              name:
                                description: |
                                  Name of the beneficiary
                                example: Ben Hur
                                maxLength: 35
                                minLength: 1
                                nullable: false
                                readOnly: false
                                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
                          payrollComponent:
                            description: |
                              The payroll component for which the outgoing payment records applies.
                              Each payroll component can only be used once per employment.

                              `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metaData
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The number for the payroll component
                                example: 260
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description of the payroll component
                                example: NETTOLOON
                                maxLength: 14
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Change the details of a payment information non-SEPA
      tags:
        - Payment information non-SEPA
  "/providers/employers/employees/employments/paymentinformationsepa/{paymentInformationSepaId}":
    delete:
      description: |
        __Activity name :__ DeletePaymentInformationSepaByPaymentInformationSepaId

        Delete an existing SEPA payment-record (for an employment)
      operationId: DeletePaymentInformationSepaBypaymentInformationSepaId
      parameters:
        - description: The unique identifier of the SEPA payment record
          in: path
          name: paymentInformationSepaId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 SEPA payment-record record
      tags:
        - Payment information
    get:
      description: |
        __Activity name :__ GetPaymentInformationSepaBypaymentInformationSepaId

        Get the detail of a payment information SEPA record.
         
        For a specific payroll component, the record indicates to which IBAN account number it should be related for the purpose of outgoing payments.  This includes, but is not limited to, the payment of wages for an employment. For each payroll component there can only be one outgoing payment record per employment.
      operationId: GetPaymentInformationSepaBypaymentInformationSepaId
      parameters:
        - description: The unique identifier of the SEPA payment record
          in: path
          name: paymentInformationSepaId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          bic:
                            description: |
                              BIC /SWIFT code. Only applicable for a non-Dutch IBAN
                            example: AUDFDE21
                            maxLength: 11
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          cityBeneficiary:
                            description: |
                              City name of beneficiary.
                            example: Rome
                            maxLength: 24
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          description1:
                            description: |
                              Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: xx
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          description2:
                            description: |
                              Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: x
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          iban:
                            description: |
                              International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                            example: NL52ABNA0424968264
                            maxLength: 35
                            minLength: 1
                            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
                          nameBeneficiary:
                            description: |
                              Name of beneficiary.
                            example: Ben Hur
                            maxLength: 70
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          payrollComponent:
                            description: |
                              The payroll component for which the outgoing payment records applies.

                              `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metaData
                            nullable: false
                            properties:
                              key:
                                example: 260
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: NETTOLOON
                                maxLength: 50
                                minLength: 0
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          visibleOnPayslip:
                            description: |
                              Indicates whether the payment-component is visible on a payslip.
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                    type: object
            application/json;version=YYYY-MM-DD:
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          beneficiary:
                            description: Information regarding the beneficiary coresponding with the bank account number
                            nullable: false
                            properties:
                              city:
                                description: |
                                  City name of beneficiary.
                                example: Rome
                                maxLength: 24
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              name:
                                description: |
                                  Name of beneficiary.
                                example: Ben Hur
                                maxLength: 70
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                            type: object
                          bic:
                            description: |
                              BIC /SWIFT code. Only applicable for a non-Dutch IBAN
                            example: AUDFDE21
                            maxLength: 11
                            minLength: 0
                            nullable: true
                            readOnly: false
                            type: string
                          description1:
                            description: |
                              Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: xx
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          description2:
                            description: |
                              Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: x
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          iban:
                            description: |
                              International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                            example: NL52ABNA0424968264
                            maxLength: 35
                            minLength: 0
                            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
                          payrollComponent:
                            description: |
                              The payroll component for which the outgoing payment records applies.

                              `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metaData
                            nullable: false
                            properties:
                              description:
                                example: NETTOLOON
                                maxLength: 50
                                minLength: 0
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                example: 260
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            readOnly: false
                            type: object
                          visibleOnPayslip:
                            description: |
                              Indicates whether the payment-component is visible on a payslip.
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                    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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the details of a payment information sepa
      tags:
        - Payment information
    put:
      description: |
        __Activity name :__ PutPaymentInformationSepaByPaymentInformationSepaId

        Edit an existing SEPA payment-record (for an employment).
        For each unique payroll component there can only be one payment record per employment.
        Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the URL
      operationId: PutPaymentInformationSepaByPaymentInformationSepaId
      parameters:
        - description: The unique identifier of the SEPA payment record
          in: path
          name: paymentInformationSepaId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                bic:
                  description: |
                    BIC /SWIFT code. Only applicable for a non-Dutch IBAN
                  example: AUDFDE21
                  maxLength: 11
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                cityBeneficiary:
                  description: |
                    City name of beneficiary.
                  example: Rome
                  maxLength: 24
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                description1:
                  description: |
                    Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                  example: xx
                  maxLength: 32
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                description2:
                  description: |
                    Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                  example: x
                  maxLength: 32
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                iban:
                  description: |
                    International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                  example: NL52ABNA0424968264
                  maxLength: 35
                  minLength: 1
                  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
                nameBeneficiary:
                  description: |
                    Name of beneficiary.
                  example: Ben Hur
                  maxLength: 70
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                payrollComponent:
                  description: |
                    The payroll component for which the outgoing payment records applies.

                    `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metaData
                  nullable: false
                  properties:
                    key:
                      example: 260
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: NETTOLOON
                      maxLength: 50
                      minLength: 0
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
                visibleOnPayslip:
                  description: |
                    Indicates whether the payment-component is visible on a payslip.
                  example: true
                  nullable: false
                  readOnly: false
                  type: boolean
          application/json;version=YYYY-MM-DD:
            schema:
              properties:
                beneficiary:
                  description: Information regarding the beneficiary coresponding with the bank account number
                  nullable: false
                  properties:
                    city:
                      description: |
                        City name of beneficiary.
                      example: Rome
                      maxLength: 24
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                    name:
                      description: |
                        Name of beneficiary.
                      example: Ben Hur
                      maxLength: 70
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                  type: object
                bic:
                  description: |
                    BIC /SWIFT code. Only applicable for a non-Dutch IBAN
                  example: AUDFDE21
                  maxLength: 11
                  minLength: 0
                  nullable: true
                  readOnly: false
                  type: string
                description1:
                  description: |
                    Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                  example: xx
                  maxLength: 32
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                description2:
                  description: |
                    Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                  example: x
                  maxLength: 32
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                iban:
                  description: |
                    International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                  example: NL52ABNA0424968264
                  maxLength: 35
                  minLength: 0
                  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
                payrollComponent:
                  description: |
                    The payroll component for which the outgoing payment records applies.

                    `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metaData
                  nullable: false
                  properties:
                    description:
                      example: NETTOLOON
                      maxLength: 50
                      minLength: 0
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      example: 260
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  readOnly: false
                  type: object
                visibleOnPayslip:
                  description: |
                    Indicates whether the payment-component is visible on a payslip.
                  example: true
                  nullable: false
                  readOnly: false
                  type: boolean
        description: SEPA payment record 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          bic:
                            description: |
                              BIC /SWIFT code. Only applicable for a non-Dutch IBAN
                            example: AUDFDE21
                            maxLength: 11
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          cityBeneficiary:
                            description: |
                              City name of beneficiary.
                            example: Rome
                            maxLength: 24
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          description1:
                            description: |
                              Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: xx
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          description2:
                            description: |
                              Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: x
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          iban:
                            description: |
                              International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                            example: NL52ABNA0424968264
                            maxLength: 35
                            minLength: 1
                            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
                          nameBeneficiary:
                            description: |
                              Name of beneficiary.
                            example: Ben Hur
                            maxLength: 70
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          payrollComponent:
                            description: |
                              The payroll component for which the outgoing payment records applies.

                              `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metaData
                            nullable: false
                            properties:
                              key:
                                example: 260
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: NETTOLOON
                                maxLength: 50
                                minLength: 0
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          visibleOnPayslip:
                            description: |
                              Indicates whether the payment-component is visible on a payslip.
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                    type: object
            application/json;version=YYYY-MM-DD:
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          beneficiary:
                            description: Information regarding the beneficiary coresponding with the bank account number
                            nullable: false
                            properties:
                              city:
                                description: |
                                  City name of beneficiary.
                                example: Rome
                                maxLength: 24
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              name:
                                description: |
                                  Name of beneficiary.
                                example: Ben Hur
                                maxLength: 70
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                            type: object
                          bic:
                            description: |
                              BIC /SWIFT code. Only applicable for a non-Dutch IBAN
                            example: AUDFDE21
                            maxLength: 11
                            minLength: 0
                            nullable: true
                            readOnly: false
                            type: string
                          description1:
                            description: |
                              Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: xx
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          description2:
                            description: |
                              Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: x
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          iban:
                            description: |
                              International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                            example: NL52ABNA0424968264
                            maxLength: 35
                            minLength: 0
                            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
                          payrollComponent:
                            description: |
                              The payroll component for which the outgoing payment records applies.

                              `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metaData
                            nullable: false
                            properties:
                              description:
                                example: NETTOLOON
                                maxLength: 50
                                minLength: 0
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                example: 260
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            readOnly: false
                            type: object
                          visibleOnPayslip:
                            description: |
                              Indicates whether the payment-component is visible on a payslip.
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: change the details of a payment information sepa
      tags:
        - Payment information
  "/providers/employers/employees/employments/paymentinformationsepaseparatepayments/{paymentInformationSepaSeparatePaymentId}":
    delete:
      description: |
        __Activity name :__ DeletePaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId

        Delete an existing SEPA payment-record (for an employment)
      operationId: DeletePaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId
      parameters:
        - description: The unique identifier of the SEPA payment record
          in: path
          name: paymentInformationSepaSeparatePaymentId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payment information SEPA separate payment record
      tags:
        - Payment information separate payments
    get:
      description: |
        __Activity name :__ GetPaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId

        Get the detail of a payment information SEPA record. For a specific payroll component, the record indicates to which IBAN account number it should be related for the purpose of outgoing payments.  This includes, but is not limited to, the payment of wages for an employment.  For each payroll component there can only be one outgoing payment record per employment.
      operationId: GetPaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId
      parameters:
        - description: The unique identifier of the SEPA payment record
          in: path
          name: paymentInformationSepaSeparatePaymentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          amount:
                            description: The amount to be split from the net salary
                            example: 32
                            format: double
                            maximum: 99999999.99
                            minimum: 0.01
                            nullable: false
                            pattern: ^(\d{1,8})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          cityBeneficiary:
                            description: |
                              City name of beneficiary
                            example: Rome
                            maxLength: 24
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          description1:
                            description: |
                              Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: Savings to different account
                            maxLength: 32
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          description2:
                            description: |
                              Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: from net wage
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          endDate:
                            description: |
                              The end date of the record
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          iban:
                            description: |
                              International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                            example: NL52ABNA0424968264
                            maxLength: 35
                            minLength: 1
                            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
                          nameBeneficiary:
                            description: |
                              Name of beneficiary
                            example: Ben Hur
                            maxLength: 70
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          startDate:
                            description: |
                              Start date of this record

                              __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for splitting from net salary at that date (based on the start- and enddate).
                            example: 2018-01-01
                            format: date
                            nullable: false
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the details of a payment information SEPA separate payment record
      tags:
        - Payment information separate payments
    put:
      description: |
        __Activity name :__ PutPaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId

        Edit an existing separate payment-record (for an employment). For each unique payroll component there can only be one payment record per employment.

        __Metadata :__ Not applicable for this resource.
      operationId: PutPaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId
      parameters:
        - description: The unique identifier of the SEPA payment record
          in: path
          name: paymentInformationSepaSeparatePaymentId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                amount:
                  description: The amount to be split from the net salary
                  example: 32
                  format: double
                  maximum: 99999999.99
                  minimum: 0.01
                  nullable: false
                  pattern: ^(\d{1,8})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                cityBeneficiary:
                  description: |
                    City name of beneficiary
                  example: Rome
                  maxLength: 24
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                description1:
                  description: |
                    Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                  example: Savings to different account
                  maxLength: 32
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                description2:
                  description: |
                    Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                  example: from net wage
                  maxLength: 32
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                endDate:
                  description: |
                    The end date of the record
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                iban:
                  description: |
                    International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                  example: NL52ABNA0424968264
                  maxLength: 35
                  minLength: 1
                  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
                nameBeneficiary:
                  description: |
                    Name of beneficiary
                  example: Ben Hur
                  maxLength: 70
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                startDate:
                  description: |
                    Start date of this record

                    __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for splitting from net salary at that date (based on the start- and enddate).
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          amount:
                            description: The amount to be split from the net salary
                            example: 32
                            format: double
                            maximum: 99999999.99
                            minimum: 0.01
                            nullable: false
                            pattern: ^(\d{1,8})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          cityBeneficiary:
                            description: |
                              City name of beneficiary
                            example: Rome
                            maxLength: 24
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          description1:
                            description: |
                              Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: Savings to different account
                            maxLength: 32
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          description2:
                            description: |
                              Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: from net wage
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          endDate:
                            description: |
                              The end date of the record
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          iban:
                            description: |
                              International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                            example: NL52ABNA0424968264
                            maxLength: 35
                            minLength: 1
                            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
                          nameBeneficiary:
                            description: |
                              Name of beneficiary
                            example: Ben Hur
                            maxLength: 70
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          startDate:
                            description: |
                              Start date of this record

                              __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for splitting from net salary at that date (based on the start- and enddate).
                            example: 2018-01-01
                            format: date
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a payment information separate payment record
      tags:
        - Payment information separate payments
  "/providers/employers/employees/employments/payrollperioddata/{payrollperioddataId}":
    delete:
      description: |
        __Activity name:__ DeletePayrollPeriodDataByPayrollPeriodDataId

        Delete a payroll period data record for the employment
      operationId: DeletePayrollPeriodDataByPayrollPeriodDataId
      parameters:
        - description: The unique identifier of the payroll period data
          in: path
          name: payrollperioddataId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payroll period data record
      tags:
        - Payroll period data
    get:
      description: |
        __Activity name :__ GetPayrollPeriodDataByPayrollPeriodDataId <br/> <br/>         Get the details of payroll period data
      operationId: GetPayrollPeriodDataByPayrollPeriodDataId
      parameters:
        - description: The unique identifier of the payroll period data
          in: path
          name: payrollperioddataId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          costCenter:
                            description: |
                              The cost center on which the payroll period data for this record will be booked for the ledger.
                            format: metadata
                            nullable: true
                            properties:
                              code:
                                example: SAL073
                                nullable: false
                                readOnly: true
                                type: string
                              description:
                                example: Sales Den Bosch
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          costUnit:
                            description: |
                              The cost unit on which the data for this record will be booked for the ledger
                            format: metadata
                            nullable: true
                            properties:
                              code:
                                example: "01"
                                nullable: false
                                readOnly: true
                                type: string
                              description:
                                example: Cars
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          distributionUnit:
                            description: |
                              Distribution unit, used in several reports and the "basic wage journal" functionality. Commonly used as a cost center.
                            format: metadata
                            nullable: false
                            properties:
                              code:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              description:
                                example: Sales
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                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
                            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
                          payrollComponents:
                            items:
                              properties:
                                isSupplement:
                                  description: |
                                    This boolean determines what the salary calculation will do with the value of the payroll component if the payroll component has values in both the payroll period specific data (this endpoint) and in the non-payroll period specific configuration of the employment (it is possible to configure values for payroll components that span multiple payroll periods and even parts thereof).

                                    * When set to `false`, the value of the payroll component will overwrite the value specified in the non-payroll period specific data with the given value in the payroll period specific date.

                                    * When set to `true`, the value of the payroll period specific data will be added to the value of the non-payroll period specific data. Note that a value can be a negative number. For instance, a payroll period specific value of 20 and a non-payroll period specific value of -8 will effectively result in 12 for salary calculation.

                                    This boolean can only be set to `true` in components for which `payrollComponent.canBesupplemented = true`.
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                payrollComponent:
                                  description: |
                                    A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment for the given payroll period.  <br/>  Please note: Business rules may differ per component! Understanding these business rules and corresponding validations requires functional knowledge of Loket.
                                  format: metadata
                                  properties:
                                    canBeSupplemented:
                                      description: |
                                        Indicates whether the atribute for this payroll component can have the value `supplement`. Refer to the description of the attribute field for an explanation.
                                      example: false
                                      nullable: false
                                      readOnly: true
                                      type: boolean
                                    category:
                                      description: |
                                        The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        value:
                                          example: Uren
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    deductionOrPayment:
                                      description: |
                                        Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
                                      format: metadata
                                      nullable: true
                                      properties:
                                        key:
                                          example: 2
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        value:
                                          example: Betaling
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    description:
                                      description: |
                                        The description of the payroll component
                                      example: Uren gewerkt
                                      maxLength: 14
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      description: |
                                        The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know it by heart.
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                value:
                                  description: |
                                    Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules).
                                  example: 144
                                  nullable: false
                                  readOnly: false
                                  type: number
                              type: object
                            type: array
                          payrollPeriod:
                            format: metadata
                            nullable: false
                            properties:
                              periodEndDate:
                                description: |
                                  The last day of the period to which the payroll period data applies
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: |
                                  The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period in which the payroll data is to be processed.
                                example: 1
                                format: int32
                                maximum: 53
                                minimum: 1
                                nullable: false
                                readOnly: true
                                type: integer
                              periodStartDate:
                                description: |
                                  The first day of the period to which the payroll period data applies
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: |
                                  The year of the payroll period in which the payroll data is to be processed
                                example: 2017
                                format: int32
                                maximum: 9999
                                minimum: 2000
                                nullable: false
                                readOnly: true
                                type: integer
                            readOnly: true
                            type: object
                          payslipText:
                            description: |
                              A custom text to be displayed on the payslip.
                            example: Additional payslip for bonus
                            maxLength: 25
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          payslipType:
                            description: |
                              The type of payslip (as defined by the Dutch tax authorities)
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Bijzonder tarief strook
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          shift:
                            description: |
                              The shift determines the full-time hours and bonus percentage.
                            format: metadata
                            nullable: false
                            properties:
                              bonusPercentage:
                                description: |
                                  The bonus percentage used in wage calculations for the hours made in this shift.
                                example: 12
                                nullable: false
                                readOnly: true
                                type: number
                              fullTimeHoursPerWeek:
                                description: |
                                  The full time hours for an employment that is linked to this shift.
                                example: 40
                                nullable: false
                                readOnly: true
                                type: number
                              shiftNumber:
                                description: |
                                  The number for the shift. Loket.nl supports a maximum of 5 shifts per payroll administration.
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payroll period data
      tags:
        - Payroll period data
    put:
      description: |
        __Activity name :__ PutPayrollPeriodDataByPayrollPeriodDataId <br/> <br/>         Edit the details for payroll period data <br/> <br/> __Metadata :__ <br/> Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL <br/> Possible values for fields of the type 'metadata' that are PERIOD-specific can be acquired (GET) by adding `/metadata/year/{year}/period/{periodNumber}` to the PUT URL     <br/>
      operationId: PutPayrollPeriodDataByPayrollPeriodDataId
      parameters:
        - description: The unique identifier of the payroll period data
          in: path
          name: payrollperioddataId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                costCenter:
                  description: |
                    The cost center on which the payroll period data for this record will be booked for the ledger.
                  format: metadata
                  nullable: true
                  properties:
                    code:
                      example: SAL073
                      nullable: false
                      readOnly: true
                      type: string
                    description:
                      example: Sales Den Bosch
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
                costUnit:
                  description: |
                    The cost unit on which the data for this record will be booked for the ledger
                  format: metadata
                  nullable: true
                  properties:
                    code:
                      example: "01"
                      nullable: false
                      readOnly: true
                      type: string
                    description:
                      example: Cars
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
                distributionUnit:
                  description: |
                    Distribution unit, used in several reports and the "basic wage journal" functionality. Commonly used as a cost center.
                  format: metadata
                  nullable: false
                  properties:
                    code:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    description:
                      example: Sales
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      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
                  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
                payrollComponents:
                  items:
                    properties:
                      isSupplement:
                        description: |
                          This boolean determines what the salary calculation will do with the value of the payroll component if the payroll component has values in both the payroll period specific data (this endpoint) and in the non-payroll period specific configuration of the employment (it is possible to configure values for payroll components that span multiple payroll periods and even parts thereof).

                          * When set to `false`, the value of the payroll component will overwrite the value specified in the non-payroll period specific data with the given value in the payroll period specific date.

                          * When set to `true`, the value of the payroll period specific data will be added to the value of the non-payroll period specific data. Note that a value can be a negative number. For instance, a payroll period specific value of 20 and a non-payroll period specific value of -8 will effectively result in 12 for salary calculation.

                          This boolean can only be set to `true` in components for which `payrollComponent.canBesupplemented = true`.
                        example: false
                        nullable: false
                        readOnly: false
                        type: boolean
                      payrollComponent:
                        description: |
                          A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment for the given payroll period.  <br/>  Please note: Business rules may differ per component! Understanding these business rules and corresponding validations requires functional knowledge of Loket.
                        format: metadata
                        properties:
                          canBeSupplemented:
                            description: |
                              Indicates whether the atribute for this payroll component can have the value `supplement`. Refer to the description of the attribute field for an explanation.
                            example: false
                            nullable: false
                            readOnly: true
                            type: boolean
                          category:
                            description: |
                              The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Uren
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          deductionOrPayment:
                            description: |
                              Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Betaling
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          description:
                            description: |
                              The description of the payroll component
                            example: Uren gewerkt
                            maxLength: 14
                            nullable: false
                            readOnly: true
                            type: string
                          key:
                            description: |
                              The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know it by heart.
                            example: 1
                            format: int32
                            nullable: false
                            readOnly: false
                            type: integer
                        type: object
                      value:
                        description: |
                          Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules).
                        example: 144
                        nullable: false
                        readOnly: false
                        type: number
                    type: object
                  type: array
                payrollPeriod:
                  format: metadata
                  nullable: false
                  properties:
                    periodEndDate:
                      description: |
                        The last day of the period to which the payroll period data applies
                      example: 2018-01-31
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    periodNumber:
                      description: |
                        The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period in which the payroll data is to be processed.
                      example: 1
                      format: int32
                      maximum: 53
                      minimum: 1
                      nullable: false
                      readOnly: true
                      type: integer
                    periodStartDate:
                      description: |
                        The first day of the period to which the payroll period data applies
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    year:
                      description: |
                        The year of the payroll period in which the payroll data is to be processed
                      example: 2017
                      format: int32
                      maximum: 9999
                      minimum: 2000
                      nullable: false
                      readOnly: true
                      type: integer
                  readOnly: true
                  type: object
                payslipText:
                  description: |
                    A custom text to be displayed on the payslip.
                  example: Additional payslip for bonus
                  maxLength: 25
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                payslipType:
                  description: |
                    The type of payslip (as defined by the Dutch tax authorities)
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    value:
                      example: Bijzonder tarief strook
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                shift:
                  description: |
                    The shift determines the full-time hours and bonus percentage.
                  format: metadata
                  nullable: false
                  properties:
                    bonusPercentage:
                      description: |
                        The bonus percentage used in wage calculations for the hours made in this shift.
                      example: 12
                      nullable: false
                      readOnly: true
                      type: number
                    fullTimeHoursPerWeek:
                      description: |
                        The full time hours for an employment that is linked to this shift.
                      example: 40
                      nullable: false
                      readOnly: true
                      type: number
                    shiftNumber:
                      description: |
                        The number for the shift. Loket.nl supports a maximum of 5 shifts per payroll administration.
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
        description: Payroll period data 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          costCenter:
                            description: |
                              The cost center on which the payroll period data for this record will be booked for the ledger.
                            format: metadata
                            nullable: true
                            properties:
                              code:
                                example: SAL073
                                nullable: false
                                readOnly: true
                                type: string
                              description:
                                example: Sales Den Bosch
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          costUnit:
                            description: |
                              The cost unit on which the data for this record will be booked for the ledger
                            format: metadata
                            nullable: true
                            properties:
                              code:
                                example: "01"
                                nullable: false
                                readOnly: true
                                type: string
                              description:
                                example: Cars
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          distributionUnit:
                            description: |
                              Distribution unit, used in several reports and the "basic wage journal" functionality. Commonly used as a cost center.
                            format: metadata
                            nullable: false
                            properties:
                              code:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              description:
                                example: Sales
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                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
                            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
                          payrollComponents:
                            items:
                              properties:
                                isSupplement:
                                  description: |
                                    This boolean determines what the salary calculation will do with the value of the payroll component if the payroll component has values in both the payroll period specific data (this endpoint) and in the non-payroll period specific configuration of the employment (it is possible to configure values for payroll components that span multiple payroll periods and even parts thereof).

                                    * When set to `false`, the value of the payroll component will overwrite the value specified in the non-payroll period specific data with the given value in the payroll period specific date.

                                    * When set to `true`, the value of the payroll period specific data will be added to the value of the non-payroll period specific data. Note that a value can be a negative number. For instance, a payroll period specific value of 20 and a non-payroll period specific value of -8 will effectively result in 12 for salary calculation.

                                    This boolean can only be set to `true` in components for which `payrollComponent.canBesupplemented = true`.
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                payrollComponent:
                                  description: |
                                    A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment for the given payroll period.  <br/>  Please note: Business rules may differ per component! Understanding these business rules and corresponding validations requires functional knowledge of Loket.
                                  format: metadata
                                  properties:
                                    canBeSupplemented:
                                      description: |
                                        Indicates whether the atribute for this payroll component can have the value `supplement`. Refer to the description of the attribute field for an explanation.
                                      example: false
                                      nullable: false
                                      readOnly: true
                                      type: boolean
                                    category:
                                      description: |
                                        The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        value:
                                          example: Uren
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    deductionOrPayment:
                                      description: |
                                        Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
                                      format: metadata
                                      nullable: true
                                      properties:
                                        key:
                                          example: 2
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        value:
                                          example: Betaling
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    description:
                                      description: |
                                        The description of the payroll component
                                      example: Uren gewerkt
                                      maxLength: 14
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      description: |
                                        The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know it by heart.
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                value:
                                  description: |
                                    Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules).
                                  example: 144
                                  nullable: false
                                  readOnly: false
                                  type: number
                              type: object
                            type: array
                          payrollPeriod:
                            format: metadata
                            nullable: false
                            properties:
                              periodEndDate:
                                description: |
                                  The last day of the period to which the payroll period data applies
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: |
                                  The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period in which the payroll data is to be processed.
                                example: 1
                                format: int32
                                maximum: 53
                                minimum: 1
                                nullable: false
                                readOnly: true
                                type: integer
                              periodStartDate:
                                description: |
                                  The first day of the period to which the payroll period data applies
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: |
                                  The year of the payroll period in which the payroll data is to be processed
                                example: 2017
                                format: int32
                                maximum: 9999
                                minimum: 2000
                                nullable: false
                                readOnly: true
                                type: integer
                            readOnly: true
                            type: object
                          payslipText:
                            description: |
                              A custom text to be displayed on the payslip.
                            example: Additional payslip for bonus
                            maxLength: 25
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          payslipType:
                            description: |
                              The type of payslip (as defined by the Dutch tax authorities)
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Bijzonder tarief strook
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          shift:
                            description: |
                              The shift determines the full-time hours and bonus percentage.
                            format: metadata
                            nullable: false
                            properties:
                              bonusPercentage:
                                description: |
                                  The bonus percentage used in wage calculations for the hours made in this shift.
                                example: 12
                                nullable: false
                                readOnly: true
                                type: number
                              fullTimeHoursPerWeek:
                                description: |
                                  The full time hours for an employment that is linked to this shift.
                                example: 40
                                nullable: false
                                readOnly: true
                                type: number
                              shiftNumber:
                                description: |
                                  The number for the shift. Loket.nl supports a maximum of 5 shifts per payroll administration.
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of an payroll period data
      tags:
        - Payroll period data
  "/providers/employers/employees/employments/pensionbenefits/{pensionBenefitId}":
    delete:
      description: |
        __Activity name :__ DeletePensionBenefitByPensionBenefitId

        Delete an existing pension benefit record
      operationId: DeletePensionBenefitByPensionBenefitId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: pensionBenefitId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 pension benefit record
      tags:
        - Pension benefit
    get:
      description: |
        __Activity name :__ GetPensionBenefitByPensionBenefitId

        Get the details of a pension benefit
      operationId: GetPensionBenefitByPensionBenefitId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: pensionBenefitId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              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
                            payout:
                              description: The ammount of (gross) pension received
                              example: 2569
                              format: double
                              maximum: 100000
                              minimum: 0
                              nullable: false
                              pattern: ^(\d{1,8})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            startDate:
                              description: |-
                                The date on which this pension benefit starts

                                A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                              example: 2018-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 pension benefit
      tags:
        - Pension benefit
    put:
      description: |
        __Activity name :__ PutPensionBenefitByPensionBenefitId

        __Metadata :__ No metadata
      operationId: PutPensionBenefitByPensionBenefitId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: pensionBenefitId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  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
                payout:
                  description: The ammount of (gross) pension received
                  example: 2569
                  format: double
                  maximum: 100000
                  minimum: 0
                  nullable: false
                  pattern: ^(\d{1,8})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                startDate:
                  description: |-
                    The date on which this pension benefit starts

                    A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            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
                          payout:
                            description: The ammount of (gross) pension received
                            example: 2569
                            format: double
                            maximum: 100000
                            minimum: 0
                            nullable: false
                            pattern: ^(\d{1,8})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          startDate:
                            description: |-
                              The date on which this pension benefit starts

                              A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2018-01-01
                            format: date
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit a pension benefit record
      tags:
        - Pension benefit
  "/providers/employers/employees/employments/protectedearnings/{protectedEarningsId}":
    delete:
      description: |
        __Activity name :__ DeleteProtectedEarningsByProtectedEarningsId

        Delete an existing protected earnings record
      operationId: DeleteProtectedEarningsByProtectedEarningsId
      parameters:
        - description: The unique identifier of a record
          in: path
          name: protectedEarningsId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 protected earnings record
      tags:
        - Protected earnings
    get:
      description: |
        __Activity name :__ GetProtectedEarningsByProtectedEarningsId

        Get the details of an protected earnings record
      operationId: GetProtectedEarningsByProtectedEarningsId
      parameters:
        - description: The unique identifier of a record
          in: path
          name: protectedEarningsId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          endDate:
                            description: |
                              The end date of the record
                            example: 2018-10-23
                            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: |
                              Start date of this record
                              A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.

                              __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for protected earning (based on the start- and enddate, not based on the payroll period of the payroll run).
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          threshold:
                            description: The total amount of net wage that is protected.
                            example: 50
                            format: double
                            maximum: 99999999.99
                            minimum: 0
                            nullable: false
                            pattern: ^(\d{1,8})(\.\d{1,2})?$
                            readOnly: false
                    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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the details of an protected earnings record
      tags:
        - Protected earnings
    put:
      description: |
        __Activity name :__ PutProtectedEarningsByProtectedEarningsId

        Update the details of a single protected earnings record

        __Metadata :__ There is no metadata for this resource
      operationId: PutProtectedEarningsByProtectedEarningsId
      parameters:
        - description: The unique identifier of a record
          in: path
          name: protectedEarningsId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                endDate:
                  description: |
                    The end date of the record
                  example: 2018-10-23
                  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: |
                    Start date of this record
                    A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.

                    __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for protected earning (based on the start- and enddate, not based on the payroll period of the payroll run).
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                threshold:
                  description: The total amount of net wage that is protected.
                  example: 50
                  format: double
                  maximum: 99999999.99
                  minimum: 0
                  nullable: false
                  pattern: ^(\d{1,8})(\.\d{1,2})?$
                  readOnly: false
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          endDate:
                            description: |
                              The end date of the record
                            example: 2018-10-23
                            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: |
                              Start date of this record
                              A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.

                              __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for protected earning (based on the start- and enddate, not based on the payroll period of the payroll run).
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          threshold:
                            description: The total amount of net wage that is protected.
                            example: 50
                            format: double
                            maximum: 99999999.99
                            minimum: 0
                            nullable: false
                            pattern: ^(\d{1,8})(\.\d{1,2})?$
                            readOnly: false
                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of an protected earnings record
      tags:
        - Protected earnings
  "/providers/employers/employees/employments/socialsecuritybenefits/{socialSecurityBenefitId}":
    delete:
      description: |
        __Activity name:__ DeleteSocialSecurityBenefitBySocialSecurityBenefitId

        Delete a social security record for the employment
      operationId: DeleteSocialSecurityBenefitBySocialSecurityBenefitId
      parameters:
        - description: The unique identifier of the social security record
          in: path
          name: socialSecurityBenefitId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 social security benefits record
      tags:
        - Social security benefits
    get:
      description: |
        __Activity name:__ GetSocialSecurityBenefitBySocialSecurityBenefitId

        Get the details of a social security benefits record
      operationId: GetSocialSecurityBenefitBySocialSecurityBenefitId
      parameters:
        - description: The unique identifier of the social security record
          in: path
          name: socialSecurityBenefitId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        allOf:
                          - nullable: false
                            properties:
                              endDate:
                                description: The end date of the entity. The date is up to and including.
                                example: 2018-10-23
                                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 start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year.

                                  A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: false
                                type: string
                              supplementation:
                                nullable: false
                                properties:
                                  percentage:
                                    description: |
                                      If supplementation is applied then the supplementation percentage (up to) is registered here.
                                    example: 35
                                    format: double
                                    maximum: 100
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,3})(\.\d{1,2})?$
                                    readOnly: false
                                    type: number
                                  type:
                                    description: |
                                      Indicates whether and how supplementation should be applied. This is used when the employer supplements the pay out percentage.
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        example: 3
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        example: Suppleren (bruto)
                                        maxLength: 50
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                type: object
                            type: object
                          - properties:
                              benefit:
                                nullable: false
                                properties:
                                  percentage:
                                    description: |
                                      Pay out percentage of the benefit (deviating from the administration). This value determines the percentage to be applied, the only exception is when type of benefit is set to AOW where the percentage cannot be in altered (=0).
                                    example: 35
                                    format: double
                                    maximum: 100
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,3})(\.\d{1,2})?$
                                    readOnly: false
                                    type: number
                                  type:
                                    description: |
                                      The type of social security benefit that is applicable. Per type of benefit a so-called closed-chain input validation is used. This field cannot be changed after the initial post.
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: true
                                        type: integer
                                      value:
                                        example: ZW eigen risico
                                        maxLength: 50
                                        nullable: false
                                        readOnly: true
                                        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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 social security benefits record
      tags:
        - Social security benefits
    put:
      description: |
        __Activity name:__ PutSocialSecurityBenefitBySocialSecurityBenefitId
        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.

        Edit the details for a social security record
      operationId: PutSocialSecurityBenefitBySocialSecurityBenefitId
      parameters:
        - description: The unique identifier of the social security record
          in: path
          name: socialSecurityBenefitId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              allOf:
                - nullable: false
                  properties:
                    endDate:
                      description: The end date of the entity. The date is up to and including.
                      example: 2018-10-23
                      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 start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year.

                        A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: false
                      type: string
                    supplementation:
                      nullable: false
                      properties:
                        percentage:
                          description: |
                            If supplementation is applied then the supplementation percentage (up to) is registered here.
                          example: 35
                          format: double
                          maximum: 100
                          minimum: 0
                          nullable: false
                          pattern: ^(\d{1,3})(\.\d{1,2})?$
                          readOnly: false
                          type: number
                        type:
                          description: |
                            Indicates whether and how supplementation should be applied. This is used when the employer supplements the pay out percentage.
                          format: metadata
                          nullable: false
                          properties:
                            key:
                              example: 3
                              format: int32
                              nullable: false
                              readOnly: false
                              type: integer
                            value:
                              example: Suppleren (bruto)
                              maxLength: 50
                              nullable: false
                              readOnly: true
                              type: string
                          type: object
                      type: object
                  type: object
                - properties:
                    benefit:
                      nullable: false
                      properties:
                        percentage:
                          description: |
                            Pay out percentage of the benefit (deviating from the administration). This value determines the percentage to be applied, the only exception is when type of benefit is set to AOW where the percentage cannot be in altered (=0).
                          example: 35
                          format: double
                          maximum: 100
                          minimum: 0
                          nullable: false
                          pattern: ^(\d{1,3})(\.\d{1,2})?$
                          readOnly: false
                          type: number
                      type: object
        description: Social security record 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        allOf:
                          - nullable: false
                            properties:
                              endDate:
                                description: The end date of the entity. The date is up to and including.
                                example: 2018-10-23
                                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 start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year.

                                  A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: false
                                type: string
                              supplementation:
                                nullable: false
                                properties:
                                  percentage:
                                    description: |
                                      If supplementation is applied then the supplementation percentage (up to) is registered here.
                                    example: 35
                                    format: double
                                    maximum: 100
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,3})(\.\d{1,2})?$
                                    readOnly: false
                                    type: number
                                  type:
                                    description: |
                                      Indicates whether and how supplementation should be applied. This is used when the employer supplements the pay out percentage.
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        example: 3
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        example: Suppleren (bruto)
                                        maxLength: 50
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                type: object
                            type: object
                          - properties:
                              benefit:
                                nullable: false
                                properties:
                                  percentage:
                                    description: |
                                      Pay out percentage of the benefit (deviating from the administration). This value determines the percentage to be applied, the only exception is when type of benefit is set to AOW where the percentage cannot be in altered (=0).
                                    example: 35
                                    format: double
                                    maximum: 100
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,3})(\.\d{1,2})?$
                                    readOnly: false
                                    type: number
                                  type:
                                    description: |
                                      The type of social security benefit that is applicable. Per type of benefit a so-called closed-chain input validation is used. This field cannot be changed after the initial post.
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: true
                                        type: integer
                                      value:
                                        example: ZW eigen risico
                                        maxLength: 50
                                        nullable: false
                                        readOnly: true
                                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a social security benefits record
      tags:
        - Social security benefits
  "/providers/employers/employees/employments/socialsecurityconfigurations/{socialSecurityConfigurationId}":
    delete:
      description: |
        __Activity name:__ DeleteSocialSecurityConfigurationBySocialSecurityConfigurationId

        Delete a social security record for the employment
      operationId: DeleteSocialSecurityConfigurationBySocialSecurityConfigurationId
      parameters:
        - description: The unique identifier of the social security record
          in: path
          name: socialSecurityConfigurationId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 social security record
      tags:
        - Social security
    get:
      description: |
        __Activity name:__ GetSocialSecurityConfigurationBySocialSecurityConfigurationId

        Get the details of a social security configuration record
      operationId: GetSocialSecurityConfigurationBySocialSecurityConfigurationId
      parameters:
        - description: The unique identifier of the social security record
          in: path
          name: socialSecurityConfigurationId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            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
                          isInsuredForOccupationalDisabilityInsuranceAct:
                            description: Will contributions for the Occupational Disability Insurance Act (WAO) be payed for this employment
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          isInsuredForSicknessBenefitsAct:
                            description: Will contributions for the  Sickness Benefits Act (ZW) be payed for this employment
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          isInsuredForUnemploymentInsuranceAct:
                            description: Will contributions for the  Unemployment Insurance Act (WW) be payed for this employment
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          startDate:
                            description: |-
                              The start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 social security record
      tags:
        - Social security
    put:
      description: |
        __Activity name:__ PutSocialSecurityConfigurationBySocialSecurityConfigurationId

        Edit the details for a social security record
      operationId: PutSocialSecurityConfigurationBySocialSecurityConfigurationId
      parameters:
        - description: The unique identifier of the social security record
          in: path
          name: socialSecurityConfigurationId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              nullable: false
              properties:
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  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
                isInsuredForOccupationalDisabilityInsuranceAct:
                  description: Will contributions for the Occupational Disability Insurance Act (WAO) be payed for this employment
                  example: true
                  nullable: false
                  readOnly: false
                  type: boolean
                isInsuredForSicknessBenefitsAct:
                  description: Will contributions for the  Sickness Benefits Act (ZW) be payed for this employment
                  example: true
                  nullable: false
                  readOnly: false
                  type: boolean
                isInsuredForUnemploymentInsuranceAct:
                  description: Will contributions for the  Unemployment Insurance Act (WW) be payed for this employment
                  example: true
                  nullable: false
                  readOnly: false
                  type: boolean
                startDate:
                  description: |-
                    The start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year.

                    A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
              type: object
        description: Social security record 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            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
                          isInsuredForOccupationalDisabilityInsuranceAct:
                            description: Will contributions for the Occupational Disability Insurance Act (WAO) be payed for this employment
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          isInsuredForSicknessBenefitsAct:
                            description: Will contributions for the  Sickness Benefits Act (ZW) be payed for this employment
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          isInsuredForUnemploymentInsuranceAct:
                            description: Will contributions for the  Unemployment Insurance Act (WW) be payed for this employment
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          startDate:
                            description: |-
                              The start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2018-01-01
                            format: date
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a social security record
      tags:
        - Social security
  "/providers/employers/employees/employments/wachtgeld/{wachtegeldenId}":
    delete:
      description: |
        __Activity name :__ DeleteWachtgeldByWachtgeldId

        Delete an existing wachtgeld record
      operationId: DeleteWachtgeldByWachtgeldId
      parameters:
        - description: The unique identifier of the record
          in: query
          name: wachtgeldId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
        - description: Automatically added
          in: path
          name: wachtegeldenId
          required: true
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 wachtgeld record
      tags:
        - Wachtgeld
    get:
      description: |
        __Activity name :__ GetWachtgeldByWachtgeldId

        Get the details of a wachtgeld record
      operationId: GetWachtgeldByWachtgeldId
      parameters:
        - description: The unique identifier of the record
          in: query
          name: wachtgeldId
          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 <TOKEN>
            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: wachtegeldenId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: true
                          properties:
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              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
                            startDate:
                              description: |-
                                The date on which this wachtgeld record starts.

                                A (linked chain)[./#section/Data/Date-chains] per wachtgeld is maintained within this resource. So only one wachtgeld record can be active at the same time. 
                              example: 2021-06-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            value:
                              description: |
                                The value for the wachtgeld.
                              example: 50.87
                              maximum: 99999.99
                              minimum: 0.01
                              nullable: true
                              pattern: ^(\d{1,5})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            valueAdditionalIncomeCivilService:
                              description: |
                                The value of additional income civil service (Neveninkomsten ambtelijk).
                              example: 50.87
                              maximum: 99999.99
                              minimum: 0.01
                              nullable: true
                              pattern: ^(\d{1,5})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            valueAdditionalIncomeNonCivilService:
                              description: |
                                The value of additional income non civil service (Neveninkomsten niet ambtelijk).
                              example: 50.87
                              maximum: 99999.99
                              minimum: 0.01
                              nullable: true
                              pattern: ^(\d{1,5})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 wachtgeld
      tags:
        - Wachtgeld
    put:
      description: |
        __Activity name :__ PutWachtgeldByWachtgeldId

        __Metadata :__ No metadata.
      operationId: PutWachtgeldByWachtgeldId
      parameters:
        - description: The unique identifier of the record
          in: query
          name: wachtgeldId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
        - description: Automatically added
          in: path
          name: wachtegeldenId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              nullable: true
              properties:
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  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
                startDate:
                  description: |-
                    The date on which this wachtgeld record starts.

                    A (linked chain)[./#section/Data/Date-chains] per wachtgeld is maintained within this resource. So only one wachtgeld record can be active at the same time. 
                  example: 2021-06-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                value:
                  description: |
                    The value for the wachtgeld.
                  example: 50.87
                  maximum: 99999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,5})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                valueAdditionalIncomeCivilService:
                  description: |
                    The value of additional income civil service (Neveninkomsten ambtelijk).
                  example: 50.87
                  maximum: 99999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,5})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                valueAdditionalIncomeNonCivilService:
                  description: |
                    The value of additional income non civil service (Neveninkomsten niet ambtelijk).
                  example: 50.87
                  maximum: 99999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,5})(\.\d{1,2})?$
                  readOnly: false
                  type: number
              type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            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
                          startDate:
                            description: |-
                              The date on which this wachtgeld record starts.

                              A (linked chain)[./#section/Data/Date-chains] per wachtgeld is maintained within this resource. So only one wachtgeld record can be active at the same time. 
                            example: 2021-06-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          value:
                            description: |
                              The value for the wachtgeld.
                            example: 50.87
                            maximum: 99999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,5})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          valueAdditionalIncomeCivilService:
                            description: |
                              The value of additional income civil service (Neveninkomsten ambtelijk).
                            example: 50.87
                            maximum: 99999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,5})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          valueAdditionalIncomeNonCivilService:
                            description: |
                              The value of additional income non civil service (Neveninkomsten niet ambtelijk).
                            example: 50.87
                            maximum: 99999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,5})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit a wachtgeld record
      tags:
        - Wachtgeld
  "/providers/employers/employees/employments/wages/{wageId}":
    delete:
      description: |
        __Activity name :__ DeleteWageByWageId

        Delete a wage record for the employment
      operationId: DeleteWageByWageId
      parameters:
        - description: The unique identifier of a wage
          in: path
          name: wageId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 wage record
      tags:
        - Wage
    get:
      description: |
        __Activity name :__ GetWageByWageId

        Get the details of a single wage
      operationId: GetWageByWageId
      parameters:
        - description: The unique identifier of a wage
          in: path
          name: wageId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        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.
                            example: true
                            nullable: true
                            readOnly: false
                            type: boolean
                          employerCosts:
                            description: |
                              The cost for the employer for this employee.
                            example: 3500
                            format: double
                            maximum: 99999.99
                            minimum: 0.01
                            nullable: true
                            readOnly: false
                            type: number
                          employerCostsType:
                            description: |
                              Indicates whether the employer costs are hourly costs or periodic costs. 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.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: hourly
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          endDate:
                            description: |
                              The end date for the information in the record.
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          grossWage:
                            description: |
                              The gross wage for the employee
                            example: 2300
                            format: double
                            maximum: 999999.99
                            minimum: 0.01
                            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.
                            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
                          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
                          isGrossWageFullTime:
                            description: |
                              Indicates whether the given grossWage is either a full-time wage or a part-time wage. Full-time wage is the default value (isGrossWageFulltime = true) and Loket.nl recommends to use this option. A full-time wage takes into account the part-time percentage of an employment. While a part-time wage does not. E.g. A full-time wage of 2400 euro’s is registered. The employments works 20 out of 40 hours (40 fours is a full-time shift) thus having a 20/40 = 50% part-time percentage. The part-time hours (deviatingHoursPerWeek) are accessible through the endpoint for working hours of an employement. In the wage calculation Loket.nl will divide the grossWage component by 50% resulting in a grossWage of 1200 euro’s. In the case of a part-time wage the part-time percentage will be ignored.
                            example: true
                            nullable: false
                            readOnly: true
                            type: boolean
                          netWage:
                            description: |
                              Net wage for the employment
                            example: 2400
                            format: double
                            maximum: 999999.99
                            minimum: 0.01
                            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.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                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. 

                              `payGrade` is a metadata field within the payroll administration/payScale 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: 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.

                              `payScale` 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: Glastuinbouw maand, Loongebouw A
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          payrollPeriodType:
                            description: |
                              Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4). The value of this field is used to further specify the meaning of grossWageType, netWageType and employerCostsType. When the key fields of these three wage types have a value 1 (meaning periodic wage), the payrollPeriodType field shows the period type (month, 4 weeks or week) applicable to the wages for the employment. E.g. If the value for grossWageType.key = 1 (periodic wage) and the value for payrollPeriodType.key = 1 (meaning Month), then the wage registerd in grossWage is a monthly wage. Note that in cases where the wage type is an hourly wage (grossWageType.key = 2), the payrollPeriodType should be ignored.
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Maand
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          startDate:
                            description: |
                              The start date for the information in the record.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                              __Note__ It is posible to have no wage record.
                            example: 1995-05-21
                            format: date
                            nullable: false
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 single wage
      tags:
        - Wage
    put:
      description: |
        __Activity name :__ PutWageByWageId

        Edit the details of a wage 

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT wage URL.

                
        The possible options for `payGrade` are scoped by a `payScale`. To obtain the pay grades for a pay scale a metadata call has to be performed with the following format `../wages/metadata/payscale/{key}`. Where {key} is the key of the `payScale` (obtained via the first metadata call) for which the pay grades are to be returned.
      operationId: PutWageByWageId
      parameters:
        - description: The unique identifier of a wage
          in: path
          name: wageId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              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.
                  example: true
                  nullable: true
                  readOnly: false
                  type: boolean
                employerCosts:
                  description: |
                    The cost for the employer for this employee.
                  example: 3500
                  format: double
                  maximum: 99999.99
                  minimum: 0.01
                  nullable: true
                  readOnly: false
                  type: number
                employerCostsType:
                  description: |
                    Indicates whether the employer costs are hourly costs or periodic costs. 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.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: hourly
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                endDate:
                  description: |
                    The end date for the information in the record.
                  format: date
                  nullable: true
                  readOnly: true
                  type: string
                grossWage:
                  description: |
                    The gross wage for the employee
                  example: 2300
                  format: double
                  maximum: 999999.99
                  minimum: 0.01
                  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.
                  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
                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
                isGrossWageFullTime:
                  description: |
                    Indicates whether the given grossWage is either a full-time wage or a part-time wage. Full-time wage is the default value (isGrossWageFulltime = true) and Loket.nl recommends to use this option. A full-time wage takes into account the part-time percentage of an employment. While a part-time wage does not. E.g. A full-time wage of 2400 euro’s is registered. The employments works 20 out of 40 hours (40 fours is a full-time shift) thus having a 20/40 = 50% part-time percentage. The part-time hours (deviatingHoursPerWeek) are accessible through the endpoint for working hours of an employement. In the wage calculation Loket.nl will divide the grossWage component by 50% resulting in a grossWage of 1200 euro’s. In the case of a part-time wage the part-time percentage will be ignored.
                  example: true
                  nullable: false
                  readOnly: true
                  type: boolean
                netWage:
                  description: |
                    Net wage for the employment
                  example: 2400
                  format: double
                  maximum: 999999.99
                  minimum: 0.01
                  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.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      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. 

                    `payGrade` is a metadata field within the payroll administration/payScale 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: 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.

                    `payScale` 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: Glastuinbouw maand, Loongebouw A
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                payrollPeriodType:
                  description: |
                    Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4). The value of this field is used to further specify the meaning of grossWageType, netWageType and employerCostsType. When the key fields of these three wage types have a value 1 (meaning periodic wage), the payrollPeriodType field shows the period type (month, 4 weeks or week) applicable to the wages for the employment. E.g. If the value for grossWageType.key = 1 (periodic wage) and the value for payrollPeriodType.key = 1 (meaning Month), then the wage registerd in grossWage is a monthly wage. Note that in cases where the wage type is an hourly wage (grossWageType.key = 2), the payrollPeriodType should be ignored.
                  nullable: false
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    value:
                      example: Maand
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                startDate:
                  description: |
                    The start date for the information in the record.

                    A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                    __Note__ It is posible to have no wage record.
                  example: 1995-05-21
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
        description: Wage 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        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.
                            example: true
                            nullable: true
                            readOnly: false
                            type: boolean
                          employerCosts:
                            description: |
                              The cost for the employer for this employee.
                            example: 3500
                            format: double
                            maximum: 99999.99
                            minimum: 0.01
                            nullable: true
                            readOnly: false
                            type: number
                          employerCostsType:
                            description: |
                              Indicates whether the employer costs are hourly costs or periodic costs. 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.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: hourly
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          endDate:
                            description: |
                              The end date for the information in the record.
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          grossWage:
                            description: |
                              The gross wage for the employee
                            example: 2300
                            format: double
                            maximum: 999999.99
                            minimum: 0.01
                            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.
                            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
                          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
                          isGrossWageFullTime:
                            description: |
                              Indicates whether the given grossWage is either a full-time wage or a part-time wage. Full-time wage is the default value (isGrossWageFulltime = true) and Loket.nl recommends to use this option. A full-time wage takes into account the part-time percentage of an employment. While a part-time wage does not. E.g. A full-time wage of 2400 euro’s is registered. The employments works 20 out of 40 hours (40 fours is a full-time shift) thus having a 20/40 = 50% part-time percentage. The part-time hours (deviatingHoursPerWeek) are accessible through the endpoint for working hours of an employement. In the wage calculation Loket.nl will divide the grossWage component by 50% resulting in a grossWage of 1200 euro’s. In the case of a part-time wage the part-time percentage will be ignored.
                            example: true
                            nullable: false
                            readOnly: true
                            type: boolean
                          netWage:
                            description: |
                              Net wage for the employment
                            example: 2400
                            format: double
                            maximum: 999999.99
                            minimum: 0.01
                            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.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                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. 

                              `payGrade` is a metadata field within the payroll administration/payScale 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: 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.

                              `payScale` 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: Glastuinbouw maand, Loongebouw A
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          payrollPeriodType:
                            description: |
                              Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4). The value of this field is used to further specify the meaning of grossWageType, netWageType and employerCostsType. When the key fields of these three wage types have a value 1 (meaning periodic wage), the payrollPeriodType field shows the period type (month, 4 weeks or week) applicable to the wages for the employment. E.g. If the value for grossWageType.key = 1 (periodic wage) and the value for payrollPeriodType.key = 1 (meaning Month), then the wage registerd in grossWage is a monthly wage. Note that in cases where the wage type is an hourly wage (grossWageType.key = 2), the payrollPeriodType should be ignored.
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Maand
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          startDate:
                            description: |
                              The start date for the information in the record.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                              __Note__ It is posible to have no wage record.
                            example: 1995-05-21
                            format: date
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit a wage
      tags:
        - Wage
  "/providers/employers/employees/employments/workinghours/{workinghoursId}":
    delete:
      description: |
        __Activity name :__ DeleteWorkingHoursByWorkingHoursId <br/> <br/>        Delete an existing working hours record (for an employment)
      operationId: DeleteWorkingHoursByWorkingHoursId
      parameters:
        - description: The unique identifier of the work detail
          in: path
          name: workinghoursId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 working hours record
      tags:
        - Working hours
    get:
      description: |
        __Activity name :__  GetWorkingHoursByWorkingHoursId <br/> <br/>  Get the details of a working hours record
      operationId: GetWorkingHoursByWorkingHoursId
      parameters:
        - description: The unique identifier of the work detail
          in: path
          name: workinghoursId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          aggregatedHoursPerWeek:
                            description: |-
                              This read-only field provides the user with a single point of knowledge as to what number of hours per week employment is actually registered in regards to the payrolling process. This number may be respectively based on the workpattern, deviating hours per week or shift hours. If the employment is an 'on call employment' (oproepkracht/invalkracht) the number is either NULL or represents the min-hours if that is applicable.
                              This field is especially useful for third-parties that want to know the number of hours per week (without having to apply specific Loket logic). I.e. this field is not visible in Loket GUI.
                            example: 24
                            format: double
                            maximum: 168
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,2})(\.\d{1,2})?$
                            readOnly: true
                            type: number
                          averageHoursPerWeek:
                            description: This field can be used to register the average hours per week an employment with varying hours works. For example, 0 hour contracts and min max contracts. The value of this field does NOT directly affect the payrolling proces.
                            example: 32
                            format: double
                            maximum: 168
                            minimum: 0
                            nullable: true
                            pattern: ^(\d{1,3})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          averageParttimeFactor:
                            description: |-
                              This field is used to register the deviating value of the parttimefactor, purely for administrative purposes. The parttimefactor is normally calculated by workinghours dividing by shifthours multplied by 100. 
                              Please note that this field is not used in the actual payroll proces! For the payroll process the number of hours is used.
                            format: double
                            maximum: 999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,3})(\.\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). Onderliggende elementen geven aan of specifieke waardes berekend moeten worden op basis van het twee wekelijks werkpatroon `workPattern`
                            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: false
                                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: false
                                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: false
                                readOnly: false
                                type: boolean
                              hoursRegularPeriod:
                                description: Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods.
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              leaveHours:
                                description: |
                                  Indicates whether then leave balances (verlof) are to be calculated based on the workpattern.  If set to false and the user is not linked to a leave policy with `applyLeaveSchedule` set to true the following fields are used for the calculation `deviatingHoursPerWeek` if null `shift.fullTimeHoursPerWeek` is used
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                            type: object
                          contractCode:
                            description: |-
                              This field is specialy made for convenience stores. The field is the type of contract.

                              `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)
                                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: If this field is empty the fulltime hours are based as defined by the shift, this optional field is used to register an overwriting value. The value can be less or more then the fulltime hours a week.
                            example: 32
                            format: double
                            maximum: 99.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: 20
                            format: int32
                            maximum: 23
                            minimum: 1
                            nullable: true
                            readOnly: false
                            type: integer
                          endDate:
                            description: |
                              The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          flexibleHoursContract:
                            description: The field indicates the type of flexible contract. If not applicable, please set to NULL.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Minimum uren contract
                                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
                          regularWorkPattern:
                            description: When the employee works the same amount of hours per day every week, then the workpattern is regular.
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          shift:
                            description: |
                              The shift determines the full-time hours and bonus percentage.

                              `shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metaData
                            nullable: false
                            properties:
                              bonusPercentage:
                                description: |
                                  The bonus percentage used in wage calculations for the hours made in this shift.
                                example: 12
                                maximum: 99
                                minimum: 0.01
                                nullable: false
                                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
                                nullable: false
                                readOnly: true
                                type: number
                              shiftNumber:
                                description: |
                                  The number for the shift.
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          shiftRateSickLeave:
                            description: |
                              The shift determines the full-time hours and bonus percentage.

                              `shiftRateSickLeave` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metadata
                            properties:
                              bonusPercentage:
                                description: |
                                  The bonus percentage used in wage calculations for the hours made in this shift.
                                example: 12
                                maximum: 99
                                minimum: 1
                                nullable: false
                                readOnly: true
                                type: number
                              fullTimeHoursPerWeek:
                                description: |
                                  The full time hours for an employment that is linked to this shift.
                                example: 40
                                maximum: 99
                                minimum: 1
                                nullable: false
                                readOnly: true
                                type: number
                              shiftNumber:
                                description: |
                                  The key number to identify the shift to be used for calculation of daily rate in case of sick leave (ziekte).
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          startDate:
                            description: |
                              Start date of the record.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          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. <br /> Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                            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
          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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the working hours
      tags:
        - Working hours
    put:
      description: |
        __Activity name :__  PutWorkingHoursByWorkingHoursId       <br/> <br/>  Create a new working hours record for an employment<br/>  Please note that so-called chain validation exists for working hours records. In other words, the time periods of records for an employment cannot overlap with each other.<br/> A new or changed startDate affects the endDate of its preceding record.<br/>  When PUT-ing a new record, the startDate must be greater then the preceding record's startDate.

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.
      operationId: PutWorkingHoursByWorkingHoursId
      parameters:
        - description: The unique identifier of the work detail
          in: path
          name: workinghoursId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                aggregatedHoursPerWeek:
                  description: |-
                    This read-only field provides the user with a single point of knowledge as to what number of hours per week employment is actually registered in regards to the payrolling process. This number may be respectively based on the workpattern, deviating hours per week or shift hours. If the employment is an 'on call employment' (oproepkracht/invalkracht) the number is either NULL or represents the min-hours if that is applicable.
                    This field is especially useful for third-parties that want to know the number of hours per week (without having to apply specific Loket logic). I.e. this field is not visible in Loket GUI.
                  example: 24
                  format: double
                  maximum: 168
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,2})(\.\d{1,2})?$
                  readOnly: true
                  type: number
                averageHoursPerWeek:
                  description: This field can be used to register the average hours per week an employment with varying hours works. For example, 0 hour contracts and min max contracts. The value of this field does NOT directly affect the payrolling proces.
                  example: 32
                  format: double
                  maximum: 168
                  minimum: 0
                  nullable: true
                  pattern: ^(\d{1,3})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                averageParttimeFactor:
                  description: |-
                    This field is used to register the deviating value of the parttimefactor, purely for administrative purposes. The parttimefactor is normally calculated by workinghours dividing by shifthours multplied by 100. 
                    Please note that this field is not used in the actual payroll proces! For the payroll process the number of hours is used.
                  format: double
                  maximum: 999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,3})(\.\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). Onderliggende elementen geven aan of specifieke waardes berekend moeten worden op basis van het twee wekelijks werkpatroon `workPattern`
                  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: false
                      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: false
                      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: false
                      readOnly: false
                      type: boolean
                    hoursRegularPeriod:
                      description: Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods.
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                    leaveHours:
                      description: |
                        Indicates whether then leave balances (verlof) are to be calculated based on the workpattern.  If set to false and the user is not linked to a leave policy with `applyLeaveSchedule` set to true the following fields are used for the calculation `deviatingHoursPerWeek` if null `shift.fullTimeHoursPerWeek` is used
                      example: true
                      nullable: false
                      readOnly: false
                      type: boolean
                  type: object
                contractCode:
                  description: |-
                    This field is specialy made for convenience stores. The field is the type of contract.

                    `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)
                      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: If this field is empty the fulltime hours are based as defined by the shift, this optional field is used to register an overwriting value. The value can be less or more then the fulltime hours a week.
                  example: 32
                  format: double
                  maximum: 99.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: 20
                  format: int32
                  maximum: 23
                  minimum: 1
                  nullable: true
                  readOnly: false
                  type: integer
                endDate:
                  description: |
                    The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: true
                  type: string
                flexibleHoursContract:
                  description: The field indicates the type of flexible contract. If not applicable, please set to NULL.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Minimum uren contract
                      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
                regularWorkPattern:
                  description: When the employee works the same amount of hours per day every week, then the workpattern is regular.
                  example: true
                  nullable: false
                  readOnly: false
                  type: boolean
                shift:
                  description: |
                    The shift determines the full-time hours and bonus percentage.

                    `shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metaData
                  nullable: false
                  properties:
                    bonusPercentage:
                      description: |
                        The bonus percentage used in wage calculations for the hours made in this shift.
                      example: 12
                      maximum: 99
                      minimum: 0.01
                      nullable: false
                      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
                      nullable: false
                      readOnly: true
                      type: number
                    shiftNumber:
                      description: |
                        The number for the shift.
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
                shiftRateSickLeave:
                  description: |
                    The shift determines the full-time hours and bonus percentage.

                    `shiftRateSickLeave` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metadata
                  properties:
                    bonusPercentage:
                      description: |
                        The bonus percentage used in wage calculations for the hours made in this shift.
                      example: 12
                      maximum: 99
                      minimum: 1
                      nullable: false
                      readOnly: true
                      type: number
                    fullTimeHoursPerWeek:
                      description: |
                        The full time hours for an employment that is linked to this shift.
                      example: 40
                      maximum: 99
                      minimum: 1
                      nullable: false
                      readOnly: true
                      type: number
                    shiftNumber:
                      description: |
                        The key number to identify the shift to be used for calculation of daily rate in case of sick leave (ziekte).
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
                startDate:
                  description: |
                    Start date of the record.

                    A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                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. <br /> Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                  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
        description: Working hours 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          aggregatedHoursPerWeek:
                            description: |-
                              This read-only field provides the user with a single point of knowledge as to what number of hours per week employment is actually registered in regards to the payrolling process. This number may be respectively based on the workpattern, deviating hours per week or shift hours. If the employment is an 'on call employment' (oproepkracht/invalkracht) the number is either NULL or represents the min-hours if that is applicable.
                              This field is especially useful for third-parties that want to know the number of hours per week (without having to apply specific Loket logic). I.e. this field is not visible in Loket GUI.
                            example: 24
                            format: double
                            maximum: 168
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,2})(\.\d{1,2})?$
                            readOnly: true
                            type: number
                          averageHoursPerWeek:
                            description: This field can be used to register the average hours per week an employment with varying hours works. For example, 0 hour contracts and min max contracts. The value of this field does NOT directly affect the payrolling proces.
                            example: 32
                            format: double
                            maximum: 168
                            minimum: 0
                            nullable: true
                            pattern: ^(\d{1,3})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          averageParttimeFactor:
                            description: |-
                              This field is used to register the deviating value of the parttimefactor, purely for administrative purposes. The parttimefactor is normally calculated by workinghours dividing by shifthours multplied by 100. 
                              Please note that this field is not used in the actual payroll proces! For the payroll process the number of hours is used.
                            format: double
                            maximum: 999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,3})(\.\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). Onderliggende elementen geven aan of specifieke waardes berekend moeten worden op basis van het twee wekelijks werkpatroon `workPattern`
                            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: false
                                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: false
                                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: false
                                readOnly: false
                                type: boolean
                              hoursRegularPeriod:
                                description: Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods.
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              leaveHours:
                                description: |
                                  Indicates whether then leave balances (verlof) are to be calculated based on the workpattern.  If set to false and the user is not linked to a leave policy with `applyLeaveSchedule` set to true the following fields are used for the calculation `deviatingHoursPerWeek` if null `shift.fullTimeHoursPerWeek` is used
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                            type: object
                          contractCode:
                            description: |-
                              This field is specialy made for convenience stores. The field is the type of contract.

                              `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)
                                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: If this field is empty the fulltime hours are based as defined by the shift, this optional field is used to register an overwriting value. The value can be less or more then the fulltime hours a week.
                            example: 32
                            format: double
                            maximum: 99.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: 20
                            format: int32
                            maximum: 23
                            minimum: 1
                            nullable: true
                            readOnly: false
                            type: integer
                          endDate:
                            description: |
                              The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          flexibleHoursContract:
                            description: The field indicates the type of flexible contract. If not applicable, please set to NULL.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Minimum uren contract
                                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
                          regularWorkPattern:
                            description: When the employee works the same amount of hours per day every week, then the workpattern is regular.
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          shift:
                            description: |
                              The shift determines the full-time hours and bonus percentage.

                              `shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metaData
                            nullable: false
                            properties:
                              bonusPercentage:
                                description: |
                                  The bonus percentage used in wage calculations for the hours made in this shift.
                                example: 12
                                maximum: 99
                                minimum: 0.01
                                nullable: false
                                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
                                nullable: false
                                readOnly: true
                                type: number
                              shiftNumber:
                                description: |
                                  The number for the shift.
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          shiftRateSickLeave:
                            description: |
                              The shift determines the full-time hours and bonus percentage.

                              `shiftRateSickLeave` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metadata
                            properties:
                              bonusPercentage:
                                description: |
                                  The bonus percentage used in wage calculations for the hours made in this shift.
                                example: 12
                                maximum: 99
                                minimum: 1
                                nullable: false
                                readOnly: true
                                type: number
                              fullTimeHoursPerWeek:
                                description: |
                                  The full time hours for an employment that is linked to this shift.
                                example: 40
                                maximum: 99
                                minimum: 1
                                nullable: false
                                readOnly: true
                                type: number
                              shiftNumber:
                                description: |
                                  The key number to identify the shift to be used for calculation of daily rate in case of sick leave (ziekte).
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          startDate:
                            description: |
                              Start date of the record.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          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. <br /> Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                            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
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the working hours
      tags:
        - Working hours
  "/providers/employers/employees/employments/{employmentId}":
    get:
      description: |
        __Activity name :__ GetEmploymentByEmploymentId

        Get the details for an employment
      operationId: GetEmploymentByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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=2019-12-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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        allOf:
                          - properties:
                              employee:
                                format: metadata
                                nullable: false
                                properties:
                                  dateOfBirth:
                                    description: |
                                      The date of birth
                                    example: 1995-05-21
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  employeeNumber:
                                    description: The employee number to uniquely identify a employee within a 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
                                  lastNamePartner:
                                    description: The last name of the partner of the employee
                                    example: Wiel
                                    maxLength: 25
                                    nullable: true
                                    readOnly: true
                                    type: string
                                  photo:
                                    description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                    example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                    format: url
                                    nullable: true
                                    readOnly: true
                                    type: string
                                  prefix:
                                    description: The prefix of the employee
                                    example: van
                                    maxLength: 10
                                    nullable: true
                                    readOnly: true
                                    type: string
                                  prefixPartner:
                                    description: The prefix of the partner of the employee
                                    example: van de
                                    maxLength: 10
                                    nullable: true
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                            type: object
                          - properties:
                              calculateWorkingHours:
                                description: |
                                  Automatically calculate working hours for the employment if the option automatically calculate hours is selected for a given period. NL: Completeren/Berekenen uren
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                              cancellationNoticeDate:
                                description: "The date on which the notice was given by either the employee or the employer. NL: DatumOpzegging"
                                example: 2018-05-31
                                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. NL: OpzegtermijnWerknemer"
                                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. NL: OpzegtermijnWerkgever"
                                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. NL: PeriodeOpzegTermijn"
                                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. NL: AanstellingTot"
                                example: 2019-01-01
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              commissionUntilDate1:
                                description: "Until date for commision #1. NL: AanstellingTot1"
                                example: 2018-05-31
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              commissionUntilDate2:
                                description: "Until date for commision #2. NL: AanstellingTot2"
                                example: 2018-05-31
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              commissionUntilDate3:
                                description: "Until date for commision #3. NL: AanstellingTot3"
                                example: 2018-05-31
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              commissionUntilDate4:
                                description: "Until date for commision #4. NL: AanstellingTot4"
                                example: 2018-05-31
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              commissionUntilDate5:
                                description: "Until date for commision #5. NL: AanstellingTot5"
                                example: 2018-05-31
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              commissionUntilDate6:
                                description: "Until date for commision #6. NL: AanstellingTot6"
                                example: 2018-05-31
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              deviatingCLAExternalParty:
                                description: "CLA (CAO) code in case of a deviating CLA for external parties . NL: CaoKlantgroepAfwijkend"
                                example: 2
                                format: int32
                                nullable: true
                                readOnly: false
                                type: integer
                              deviatingCLATaxReturn:
                                description: "CLA (CAO) code in case of a deviating CLA for tax returns. NL: CAOUWV"
                                example: 2
                                format: int32
                                maximum: 9999
                                minimum: 1
                                nullable: true
                                readOnly: false
                                type: integer
                              emailLeaveRequest:
                                description: "Recipient e-mail adress for notification in case of leave requests. NL: EmailVerlofaanvraag"
                                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. NL: WerknemerProfielID

                                  `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
                              employmentCategoryType:
                                description: "A selection of special pre defined employment-types for the employment.  NL: Type dienstverband"
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  value:
                                    example: Ouderschapsverlof
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              employmentContractType:
                                description: "The type of employment applicable for the employment. NL: BasisDienstverband"
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Arbeidsovereenkomst (excl BBL)
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              employmentDurationType:
                                description: "A selection of pre defined durations for the employment. NL: SoortDienstverband"
                                format: metadata
                                nullable: false
                                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
                              endDate:
                                description: "The date on which the employment ends. NL: DatumUitDienst"
                                example: 2018-10-23
                                format: date
                                nullable: true
                                readOnly: true
                                type: string
                              endOfEmploymentDueToIllness:
                                description: "Indicates whether the reason for the termination of an employment is due to long-term illness. NL: ZiekUitDienst"
                                example: false
                                nullable: true
                                readOnly: true
                                type: boolean
                              endOfEmploymentReason:
                                description: |-
                                  The reason for the end of the employment. NL: RedenEindeDienstverband

                                  __Note:__ as of 2020-01-01 `endOfEmploymentReasonTaxAuthorities` replaces this field as the main reason for the end of the employment. We say 'main reason' as in certain cases this field still has a purpose. 
                                  Please set this field to 8 (Others) unless one of the following integrations is used for this employment
                                    * UPA-pensioenaangifte
                                    * Cordares
                                    * APG-pensioenaangifte
                                    * Achmea
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    description: The key for the reason for the end of the employment.
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: The description of the reason for the end of the employment.
                                    example: VUT
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              endOfEmploymentReasonTaxAuthorities:
                                description: |-
                                  The reason for the end of the employment as specified by the Dutch Tax authorties. NL: RedenEindeDienstverbandAangifte

                                  __Note:__ This field replaces `endOfEmploymentReason` as of 2020-01-01. `endOfEmploymentReason` will remain as a field in the resource as several integration require this field still.
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    description: The key for the reason for the end of the employment.
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: The description of the reason for the end of the employment.
                                    example: Beëindiging arbeidsovereenkomst met wederzijds goedvinden op initiatief van de werkgever.
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              essMutationSet:
                                description: |-
                                  References to a specified set of payrollcomponents that are to accessible via ESS for employee mutations. Standard-set means the standard set defined for the administration will be applied for this employment. NULL means no set will be defined for this employment (so no access to any components). NL : ExportsetID

                                  `essMutationSet` is a metadata field within the werkgever/provider context. Possible values can be managed by the user.
                                format: metadata
                                nullable: false
                                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). NL: CodeUitzondering"
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    example: 0
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Geen uitzondering.
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              exemptionPremiumWaiverMarginalLabour:
                                description: "Indicates whether an exemption (i.e. waiver) on the premium marginal labour (vrijstelling marginale arbeid) applies for this employment. NL: PremieVrijstellingMarginaleArbeid"
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              exemptionWorkRelatedExpenseScheme:
                                description: "Indicates whether an exemption (i.e. non-participation) on the work-related expense scheme (werkkostenregeling) applies for this employment. NL: WerkkostenRegelingUitsluiting"
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              firstDayNotification:
                                description: "Indicates whether a first-day notification (EersteDagsMelding) was created for the employment. Attention: this indication cannot be altered after an employment has been created. NL: EersteDagsMelding "
                                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. NL: SoortOproepkrachtOfInvalkracht
                                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. NL: HistorischeDatumInDienst"
                                example: 2012-05-01
                                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
                              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. NL: NummerInkomstenVerhouding"
                                example: 12
                                format: int32
                                maximum: 9999
                                nullable: false
                                readOnly: false
                                type: integer
                              isAnonymousEmployee:
                                description: |
                                  An employee that wants to remain anonymous related to social security instances. NL: IsAnoniemeWerknemer
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                              isDirectorAndMajorShareholder:
                                description: "Indicates whether the employment can be classified as a director and major shareholder (Dutch: directeur-grootaandeelhouder or DGA). This field can be `null` in cases where it is unknown whether the employment can be classified as a director and major shareholder. NL: IsDirecteurGrootAandeelhouder"
                                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. NL: IsFamilieVanEigenaar"
                                example: false
                                nullable: true
                                readOnly: false
                                type: boolean
                              isGemoedsbezwaardEmployeeInsurance:
                                description: |
                                  Gemoedsbezwaard Werknemerverzekering. NL: IsGemoedsbezwaardWerknemerverzekering
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                              isGemoedsbezwaardNationalInsurance:
                                description: |
                                  Gemoedsbezwaard Volksverzekering. NL: IsGemoedsbezwaardVolksverzekering
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                              isOnCallEmployment:
                                description: |
                                  Indicates whether the employment is an on-call employment. This field can be `null` in cases where it is unknown whether the employment is an on-call employment. NL: IsOproepkrachtOfInvalkracht
                                example: true
                                nullable: false
                                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. NL: IsVorigeEigenaar"
                                example: false
                                nullable: true
                                readOnly: false
                                type: boolean
                              linkedEmployment:
                                description: The unique identifier of an object (GUID/UUID)
                                example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                format: uuid
                                nullable: true
                                pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                readOnly: true
                                type: string
                              namePayslip:
                                description: "Name that is visible on payslips for the employment. NL: NaamLoonstrook"
                                example: Steve Jobs
                                maxLength: 34
                                nullable: true
                                readOnly: false
                                type: string
                              nonPayrollAdministration:
                                description: |-
                                  Id of the non-payroll administration. This field cannot simultaneously have a value with payrollAdministration (only one can have a value at a time)

                                  `nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                                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: true
                                    type: string
                                  name:
                                    description: Name of the non payroll administration
                                    example: HR only employees
                                    maxLength: 70
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              participation55plusRegulationUWV:
                                description: "Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment. NL: Deelname55Plus"
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              payrollAdministration:
                                description: |-
                                  Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time)

                                  `payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                                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: true
                                    type: string
                                  name:
                                    description: Name of the payroll administration
                                    example: ABC accountants
                                    maxLength: 70
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              payrollId:
                                description: "The payrolling number for this employment of the employee. Used by the payroll engine. This number is automatically generated and cannot be changed by the user. NL: PersoneelsnummerVerloning"
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              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’. NL: PeriodeSalarisPeriodiek"
                                example: 2
                                format: int32
                                maximum: 52
                                minimum: 1
                                nullable: true
                                readOnly: false
                                type: integer
                              professionCode:
                                description: "A code field for a profession. This field only applies in case of a specific CLA (Bouw / Infra). Please leave empty if not applicable. NL: BeroepUWV"
                                example: 4
                                format: int32
                                maximum: 999
                                minimum: 1
                                nullable: true
                                readOnly: false
                                type: integer
                              sendToExternalParty:
                                description: "Indicates whether payroll information of this employment is sent to external pension funds. Attention: this indication ONLY applies regarding the information to pension funds. If NULL then setting according to regulation is leading. NL: AanleveringExternePartij"
                                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
                              signalPayGradeAdjustment:
                                description: "Indicates whether signaling regarding salary scale adjustments are enabled for the employment. NL: SalarisschaalSignaleren"
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              specialIncomeRatio:
                                description: "Indicates the special income ratio. NL: SpecialeInkomstenVerhouding"
                                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. NL: AanvangOpzegtermijn"
                                example: 2018-06-01
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              startDate:
                                description: "The date on which this employment starts. NL: DatumInDienst"
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              startDateContractOfIndefiniteDuration:
                                description: "When did the value of `employmentDurationType` change for definite to indefinite. NL: Startdatum onbepaalde tijd This value should be te samen as the `startDate` if the contract was indefinite from the start."
                                example: 2018-05-08
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              temporaryTaxExemption:
                                description: "Indicates whether there a temporary tax exemption is to be applied for the employment. NL: TijdelijkeHeffingskorting"
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Nee.
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              typeOfEmployee:
                                description: "A selection of pre defined employee-types for the employment. NL: SoortWerknemer"
                                format: metadata
                                nullable: false
                                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 (product required). NL: AardDeelnemerschap"
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 0
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: n.vt.
                                    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. NL: Vakantiebonnen"
                                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 (product required). NL: WaardeDeelnemerschap"
                                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
                              wachtgeldOldRegulation:
                                description: "Indicates whether the (old) wachtgeld regulation is applicable for the employment. NL: WachtgeldOudeRegeling"
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              writtenEmploymentContract:
                                description: "Did the employment and employer make a written contract? NL: Schriftelijke overeenkomst"
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employment
      tags:
        - Employment
    patch:
      description: |
        __Activity name :__ PatchTypeOfEmploymentCategoryTypeFieldsByEmploymentId

        Edit a small subset of fields of an employment. 

        Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the URL
      operationId: PatchTypeOfEmploymentCategoryTypeFieldsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2019-12-16:
            schema:
              properties:
                employmentCategoryType:
                  description: "A selection of special pre defined employment-types for the employment.  NL: Type dienstverband"
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Ouderschapsverlof
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                linkedEmployment:
                  description: The unique identifier of an object (GUID/UUID)
                  example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                  format: uuid
                  nullable: true
                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                  readOnly: false
                  type: string
              type: object
        description: Employment to edit
        required: true
      responses:
        "200":
          content:
            application/json;version=2019-12-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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          employmentCategoryType:
                            description: "A selection of special pre defined employment-types for the employment.  NL: Type dienstverband"
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Ouderschapsverlof
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          linkedEmployment:
                            description: The unique identifier of an object (GUID/UUID)
                            example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                            format: uuid
                            nullable: true
                            pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the type of an employment
      tags:
        - Employment
    put:
      description: |
        __Activity name :__ PutEmploymentByEmploymentId

        Edit the details of an employment

        Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the URL
      operationId: PutEmploymentByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2019-12-16:
            schema:
              allOf:
                - properties:
                    employee:
                      format: metadata
                      nullable: false
                      properties:
                        dateOfBirth:
                          description: |
                            The date of birth
                          example: 1995-05-21
                          format: date
                          nullable: false
                          readOnly: true
                          type: string
                        employeeNumber:
                          description: The employee number to uniquely identify a employee within a 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
                        lastNamePartner:
                          description: The last name of the partner of the employee
                          example: Wiel
                          maxLength: 25
                          nullable: true
                          readOnly: true
                          type: string
                        photo:
                          description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                          example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                          format: url
                          nullable: true
                          readOnly: true
                          type: string
                        prefix:
                          description: The prefix of the employee
                          example: van
                          maxLength: 10
                          nullable: true
                          readOnly: true
                          type: string
                        prefixPartner:
                          description: The prefix of the partner of the employee
                          example: van de
                          maxLength: 10
                          nullable: true
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                  type: object
                - properties:
                    calculateWorkingHours:
                      description: |
                        Automatically calculate working hours for the employment if the option automatically calculate hours is selected for a given period. NL: Completeren/Berekenen uren
                      example: true
                      nullable: false
                      readOnly: false
                      type: boolean
                    cancellationNoticeDate:
                      description: "The date on which the notice was given by either the employee or the employer. NL: DatumOpzegging"
                      example: 2018-05-31
                      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. NL: OpzegtermijnWerknemer"
                      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. NL: OpzegtermijnWerkgever"
                      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. NL: PeriodeOpzegTermijn"
                      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. NL: AanstellingTot"
                      example: 2019-01-01
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    commissionUntilDate1:
                      description: "Until date for commision #1. NL: AanstellingTot1"
                      example: 2018-05-31
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    commissionUntilDate2:
                      description: "Until date for commision #2. NL: AanstellingTot2"
                      example: 2018-05-31
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    commissionUntilDate3:
                      description: "Until date for commision #3. NL: AanstellingTot3"
                      example: 2018-05-31
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    commissionUntilDate4:
                      description: "Until date for commision #4. NL: AanstellingTot4"
                      example: 2018-05-31
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    commissionUntilDate5:
                      description: "Until date for commision #5. NL: AanstellingTot5"
                      example: 2018-05-31
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    commissionUntilDate6:
                      description: "Until date for commision #6. NL: AanstellingTot6"
                      example: 2018-05-31
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    deviatingCLAExternalParty:
                      description: "CLA (CAO) code in case of a deviating CLA for external parties . NL: CaoKlantgroepAfwijkend"
                      example: 2
                      format: int32
                      nullable: true
                      readOnly: false
                      type: integer
                    deviatingCLATaxReturn:
                      description: "CLA (CAO) code in case of a deviating CLA for tax returns. NL: CAOUWV"
                      example: 2
                      format: int32
                      maximum: 9999
                      minimum: 1
                      nullable: true
                      readOnly: false
                      type: integer
                    emailLeaveRequest:
                      description: "Recipient e-mail adress for notification in case of leave requests. NL: EmailVerlofaanvraag"
                      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. NL: WerknemerProfielID

                        `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
                    employmentCategoryType:
                      description: "A selection of special pre defined employment-types for the employment.  NL: Type dienstverband"
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          example: 1
                          format: int32
                          nullable: false
                          readOnly: true
                          type: integer
                        value:
                          example: Ouderschapsverlof
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    employmentContractType:
                      description: "The type of employment applicable for the employment. NL: BasisDienstverband"
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 1
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: Arbeidsovereenkomst (excl BBL)
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    employmentDurationType:
                      description: "A selection of pre defined durations for the employment. NL: SoortDienstverband"
                      format: metadata
                      nullable: false
                      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
                    endDate:
                      description: "The date on which the employment ends. NL: DatumUitDienst"
                      example: 2018-10-23
                      format: date
                      nullable: true
                      readOnly: true
                      type: string
                    endOfEmploymentDueToIllness:
                      description: "Indicates whether the reason for the termination of an employment is due to long-term illness. NL: ZiekUitDienst"
                      example: false
                      nullable: true
                      readOnly: true
                      type: boolean
                    endOfEmploymentReason:
                      description: |-
                        The reason for the end of the employment. NL: RedenEindeDienstverband

                        __Note:__ as of 2020-01-01 `endOfEmploymentReasonTaxAuthorities` replaces this field as the main reason for the end of the employment. We say 'main reason' as in certain cases this field still has a purpose. 
                        Please set this field to 8 (Others) unless one of the following integrations is used for this employment
                          * UPA-pensioenaangifte
                          * Cordares
                          * APG-pensioenaangifte
                          * Achmea
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          description: The key for the reason for the end of the employment.
                          example: 1
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          description: The description of the reason for the end of the employment.
                          example: VUT
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    endOfEmploymentReasonTaxAuthorities:
                      description: |-
                        The reason for the end of the employment as specified by the Dutch Tax authorties. NL: RedenEindeDienstverbandAangifte

                        __Note:__ This field replaces `endOfEmploymentReason` as of 2020-01-01. `endOfEmploymentReason` will remain as a field in the resource as several integration require this field still.
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          description: The key for the reason for the end of the employment.
                          example: 1
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          description: The description of the reason for the end of the employment.
                          example: Beëindiging arbeidsovereenkomst met wederzijds goedvinden op initiatief van de werkgever.
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    essMutationSet:
                      description: |-
                        References to a specified set of payrollcomponents that are to accessible via ESS for employee mutations. Standard-set means the standard set defined for the administration will be applied for this employment. NULL means no set will be defined for this employment (so no access to any components). NL : ExportsetID

                        `essMutationSet` is a metadata field within the werkgever/provider context. Possible values can be managed by the user.
                      format: metadata
                      nullable: false
                      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). NL: CodeUitzondering"
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          example: 0
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: Geen uitzondering.
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    exemptionPremiumWaiverMarginalLabour:
                      description: "Indicates whether an exemption (i.e. waiver) on the premium marginal labour (vrijstelling marginale arbeid) applies for this employment. NL: PremieVrijstellingMarginaleArbeid"
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                    exemptionWorkRelatedExpenseScheme:
                      description: "Indicates whether an exemption (i.e. non-participation) on the work-related expense scheme (werkkostenregeling) applies for this employment. NL: WerkkostenRegelingUitsluiting"
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                    firstDayNotification:
                      description: "Indicates whether a first-day notification (EersteDagsMelding) was created for the employment. Attention: this indication cannot be altered after an employment has been created. NL: EersteDagsMelding "
                      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. NL: SoortOproepkrachtOfInvalkracht
                      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. NL: HistorischeDatumInDienst"
                      example: 2012-05-01
                      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
                    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. NL: NummerInkomstenVerhouding"
                      example: 12
                      format: int32
                      maximum: 9999
                      nullable: false
                      readOnly: false
                      type: integer
                    isAnonymousEmployee:
                      description: |
                        An employee that wants to remain anonymous related to social security instances. NL: IsAnoniemeWerknemer
                      example: true
                      nullable: false
                      readOnly: false
                      type: boolean
                    isDirectorAndMajorShareholder:
                      description: "Indicates whether the employment can be classified as a director and major shareholder (Dutch: directeur-grootaandeelhouder or DGA). This field can be `null` in cases where it is unknown whether the employment can be classified as a director and major shareholder. NL: IsDirecteurGrootAandeelhouder"
                      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. NL: IsFamilieVanEigenaar"
                      example: false
                      nullable: true
                      readOnly: false
                      type: boolean
                    isGemoedsbezwaardEmployeeInsurance:
                      description: |
                        Gemoedsbezwaard Werknemerverzekering. NL: IsGemoedsbezwaardWerknemerverzekering
                      example: true
                      nullable: false
                      readOnly: false
                      type: boolean
                    isGemoedsbezwaardNationalInsurance:
                      description: |
                        Gemoedsbezwaard Volksverzekering. NL: IsGemoedsbezwaardVolksverzekering
                      example: true
                      nullable: false
                      readOnly: false
                      type: boolean
                    isOnCallEmployment:
                      description: |
                        Indicates whether the employment is an on-call employment. This field can be `null` in cases where it is unknown whether the employment is an on-call employment. NL: IsOproepkrachtOfInvalkracht
                      example: true
                      nullable: false
                      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. NL: IsVorigeEigenaar"
                      example: false
                      nullable: true
                      readOnly: false
                      type: boolean
                    linkedEmployment:
                      description: The unique identifier of an object (GUID/UUID)
                      example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      format: uuid
                      nullable: true
                      pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                      readOnly: true
                      type: string
                    namePayslip:
                      description: "Name that is visible on payslips for the employment. NL: NaamLoonstrook"
                      example: Steve Jobs
                      maxLength: 34
                      nullable: true
                      readOnly: false
                      type: string
                    nonPayrollAdministration:
                      description: |-
                        Id of the non-payroll administration. This field cannot simultaneously have a value with payrollAdministration (only one can have a value at a time)

                        `nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                      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: true
                          type: string
                        name:
                          description: Name of the non payroll administration
                          example: HR only employees
                          maxLength: 70
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    participation55plusRegulationUWV:
                      description: "Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment. NL: Deelname55Plus"
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                    payrollAdministration:
                      description: |-
                        Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time)

                        `payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                      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: true
                          type: string
                        name:
                          description: Name of the payroll administration
                          example: ABC accountants
                          maxLength: 70
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    payrollId:
                      description: "The payrolling number for this employment of the employee. Used by the payroll engine. This number is automatically generated and cannot be changed by the user. NL: PersoneelsnummerVerloning"
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    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’. NL: PeriodeSalarisPeriodiek"
                      example: 2
                      format: int32
                      maximum: 52
                      minimum: 1
                      nullable: true
                      readOnly: false
                      type: integer
                    professionCode:
                      description: "A code field for a profession. This field only applies in case of a specific CLA (Bouw / Infra). Please leave empty if not applicable. NL: BeroepUWV"
                      example: 4
                      format: int32
                      maximum: 999
                      minimum: 1
                      nullable: true
                      readOnly: false
                      type: integer
                    sendToExternalParty:
                      description: "Indicates whether payroll information of this employment is sent to external pension funds. Attention: this indication ONLY applies regarding the information to pension funds. If NULL then setting according to regulation is leading. NL: AanleveringExternePartij"
                      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
                    signalPayGradeAdjustment:
                      description: "Indicates whether signaling regarding salary scale adjustments are enabled for the employment. NL: SalarisschaalSignaleren"
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                    specialIncomeRatio:
                      description: "Indicates the special income ratio. NL: SpecialeInkomstenVerhouding"
                      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. NL: AanvangOpzegtermijn"
                      example: 2018-06-01
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    startDate:
                      description: "The date on which this employment starts. NL: DatumInDienst"
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    startDateContractOfIndefiniteDuration:
                      description: "When did the value of `employmentDurationType` change for definite to indefinite. NL: Startdatum onbepaalde tijd This value should be te samen as the `startDate` if the contract was indefinite from the start."
                      example: 2018-05-08
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    temporaryTaxExemption:
                      description: "Indicates whether there a temporary tax exemption is to be applied for the employment. NL: TijdelijkeHeffingskorting"
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: Nee.
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    typeOfEmployee:
                      description: "A selection of pre defined employee-types for the employment. NL: SoortWerknemer"
                      format: metadata
                      nullable: false
                      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 (product required). NL: AardDeelnemerschap"
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 0
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: n.vt.
                          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. NL: Vakantiebonnen"
                      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 (product required). NL: WaardeDeelnemerschap"
                      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
                    wachtgeldOldRegulation:
                      description: "Indicates whether the (old) wachtgeld regulation is applicable for the employment. NL: WachtgeldOudeRegeling"
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                    writtenEmploymentContract:
                      description: "Did the employment and employer make a written contract? NL: Schriftelijke overeenkomst"
                      example: true
                      nullable: false
                      readOnly: false
                      type: boolean
                  type: object
        description: Employment to edit
        required: true
      responses:
        "200":
          content:
            application/json;version=2019-12-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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        allOf:
                          - properties:
                              employee:
                                format: metadata
                                nullable: false
                                properties:
                                  dateOfBirth:
                                    description: |
                                      The date of birth
                                    example: 1995-05-21
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  employeeNumber:
                                    description: The employee number to uniquely identify a employee within a 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
                                  lastNamePartner:
                                    description: The last name of the partner of the employee
                                    example: Wiel
                                    maxLength: 25
                                    nullable: true
                                    readOnly: true
                                    type: string
                                  photo:
                                    description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                    example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                    format: url
                                    nullable: true
                                    readOnly: true
                                    type: string
                                  prefix:
                                    description: The prefix of the employee
                                    example: van
                                    maxLength: 10
                                    nullable: true
                                    readOnly: true
                                    type: string
                                  prefixPartner:
                                    description: The prefix of the partner of the employee
                                    example: van de
                                    maxLength: 10
                                    nullable: true
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                            type: object
                          - properties:
                              calculateWorkingHours:
                                description: |
                                  Automatically calculate working hours for the employment if the option automatically calculate hours is selected for a given period. NL: Completeren/Berekenen uren
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                              cancellationNoticeDate:
                                description: "The date on which the notice was given by either the employee or the employer. NL: DatumOpzegging"
                                example: 2018-05-31
                                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. NL: OpzegtermijnWerknemer"
                                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. NL: OpzegtermijnWerkgever"
                                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. NL: PeriodeOpzegTermijn"
                                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. NL: AanstellingTot"
                                example: 2019-01-01
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              commissionUntilDate1:
                                description: "Until date for commision #1. NL: AanstellingTot1"
                                example: 2018-05-31
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              commissionUntilDate2:
                                description: "Until date for commision #2. NL: AanstellingTot2"
                                example: 2018-05-31
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              commissionUntilDate3:
                                description: "Until date for commision #3. NL: AanstellingTot3"
                                example: 2018-05-31
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              commissionUntilDate4:
                                description: "Until date for commision #4. NL: AanstellingTot4"
                                example: 2018-05-31
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              commissionUntilDate5:
                                description: "Until date for commision #5. NL: AanstellingTot5"
                                example: 2018-05-31
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              commissionUntilDate6:
                                description: "Until date for commision #6. NL: AanstellingTot6"
                                example: 2018-05-31
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              deviatingCLAExternalParty:
                                description: "CLA (CAO) code in case of a deviating CLA for external parties . NL: CaoKlantgroepAfwijkend"
                                example: 2
                                format: int32
                                nullable: true
                                readOnly: false
                                type: integer
                              deviatingCLATaxReturn:
                                description: "CLA (CAO) code in case of a deviating CLA for tax returns. NL: CAOUWV"
                                example: 2
                                format: int32
                                maximum: 9999
                                minimum: 1
                                nullable: true
                                readOnly: false
                                type: integer
                              emailLeaveRequest:
                                description: "Recipient e-mail adress for notification in case of leave requests. NL: EmailVerlofaanvraag"
                                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. NL: WerknemerProfielID

                                  `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
                              employmentCategoryType:
                                description: "A selection of special pre defined employment-types for the employment.  NL: Type dienstverband"
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  value:
                                    example: Ouderschapsverlof
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              employmentContractType:
                                description: "The type of employment applicable for the employment. NL: BasisDienstverband"
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Arbeidsovereenkomst (excl BBL)
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              employmentDurationType:
                                description: "A selection of pre defined durations for the employment. NL: SoortDienstverband"
                                format: metadata
                                nullable: false
                                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
                              endDate:
                                description: "The date on which the employment ends. NL: DatumUitDienst"
                                example: 2018-10-23
                                format: date
                                nullable: true
                                readOnly: true
                                type: string
                              endOfEmploymentDueToIllness:
                                description: "Indicates whether the reason for the termination of an employment is due to long-term illness. NL: ZiekUitDienst"
                                example: false
                                nullable: true
                                readOnly: true
                                type: boolean
                              endOfEmploymentReason:
                                description: |-
                                  The reason for the end of the employment. NL: RedenEindeDienstverband

                                  __Note:__ as of 2020-01-01 `endOfEmploymentReasonTaxAuthorities` replaces this field as the main reason for the end of the employment. We say 'main reason' as in certain cases this field still has a purpose. 
                                  Please set this field to 8 (Others) unless one of the following integrations is used for this employment
                                    * UPA-pensioenaangifte
                                    * Cordares
                                    * APG-pensioenaangifte
                                    * Achmea
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    description: The key for the reason for the end of the employment.
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: The description of the reason for the end of the employment.
                                    example: VUT
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              endOfEmploymentReasonTaxAuthorities:
                                description: |-
                                  The reason for the end of the employment as specified by the Dutch Tax authorties. NL: RedenEindeDienstverbandAangifte

                                  __Note:__ This field replaces `endOfEmploymentReason` as of 2020-01-01. `endOfEmploymentReason` will remain as a field in the resource as several integration require this field still.
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    description: The key for the reason for the end of the employment.
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: The description of the reason for the end of the employment.
                                    example: Beëindiging arbeidsovereenkomst met wederzijds goedvinden op initiatief van de werkgever.
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              essMutationSet:
                                description: |-
                                  References to a specified set of payrollcomponents that are to accessible via ESS for employee mutations. Standard-set means the standard set defined for the administration will be applied for this employment. NULL means no set will be defined for this employment (so no access to any components). NL : ExportsetID

                                  `essMutationSet` is a metadata field within the werkgever/provider context. Possible values can be managed by the user.
                                format: metadata
                                nullable: false
                                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). NL: CodeUitzondering"
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    example: 0
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Geen uitzondering.
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              exemptionPremiumWaiverMarginalLabour:
                                description: "Indicates whether an exemption (i.e. waiver) on the premium marginal labour (vrijstelling marginale arbeid) applies for this employment. NL: PremieVrijstellingMarginaleArbeid"
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              exemptionWorkRelatedExpenseScheme:
                                description: "Indicates whether an exemption (i.e. non-participation) on the work-related expense scheme (werkkostenregeling) applies for this employment. NL: WerkkostenRegelingUitsluiting"
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              firstDayNotification:
                                description: "Indicates whether a first-day notification (EersteDagsMelding) was created for the employment. Attention: this indication cannot be altered after an employment has been created. NL: EersteDagsMelding "
                                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. NL: SoortOproepkrachtOfInvalkracht
                                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. NL: HistorischeDatumInDienst"
                                example: 2012-05-01
                                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
                              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. NL: NummerInkomstenVerhouding"
                                example: 12
                                format: int32
                                maximum: 9999
                                nullable: false
                                readOnly: false
                                type: integer
                              isAnonymousEmployee:
                                description: |
                                  An employee that wants to remain anonymous related to social security instances. NL: IsAnoniemeWerknemer
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                              isDirectorAndMajorShareholder:
                                description: "Indicates whether the employment can be classified as a director and major shareholder (Dutch: directeur-grootaandeelhouder or DGA). This field can be `null` in cases where it is unknown whether the employment can be classified as a director and major shareholder. NL: IsDirecteurGrootAandeelhouder"
                                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. NL: IsFamilieVanEigenaar"
                                example: false
                                nullable: true
                                readOnly: false
                                type: boolean
                              isGemoedsbezwaardEmployeeInsurance:
                                description: |
                                  Gemoedsbezwaard Werknemerverzekering. NL: IsGemoedsbezwaardWerknemerverzekering
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                              isGemoedsbezwaardNationalInsurance:
                                description: |
                                  Gemoedsbezwaard Volksverzekering. NL: IsGemoedsbezwaardVolksverzekering
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                              isOnCallEmployment:
                                description: |
                                  Indicates whether the employment is an on-call employment. This field can be `null` in cases where it is unknown whether the employment is an on-call employment. NL: IsOproepkrachtOfInvalkracht
                                example: true
                                nullable: false
                                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. NL: IsVorigeEigenaar"
                                example: false
                                nullable: true
                                readOnly: false
                                type: boolean
                              linkedEmployment:
                                description: The unique identifier of an object (GUID/UUID)
                                example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                format: uuid
                                nullable: true
                                pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                readOnly: true
                                type: string
                              namePayslip:
                                description: "Name that is visible on payslips for the employment. NL: NaamLoonstrook"
                                example: Steve Jobs
                                maxLength: 34
                                nullable: true
                                readOnly: false
                                type: string
                              nonPayrollAdministration:
                                description: |-
                                  Id of the non-payroll administration. This field cannot simultaneously have a value with payrollAdministration (only one can have a value at a time)

                                  `nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                                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: true
                                    type: string
                                  name:
                                    description: Name of the non payroll administration
                                    example: HR only employees
                                    maxLength: 70
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              participation55plusRegulationUWV:
                                description: "Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment. NL: Deelname55Plus"
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              payrollAdministration:
                                description: |-
                                  Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time)

                                  `payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                                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: true
                                    type: string
                                  name:
                                    description: Name of the payroll administration
                                    example: ABC accountants
                                    maxLength: 70
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              payrollId:
                                description: "The payrolling number for this employment of the employee. Used by the payroll engine. This number is automatically generated and cannot be changed by the user. NL: PersoneelsnummerVerloning"
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              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’. NL: PeriodeSalarisPeriodiek"
                                example: 2
                                format: int32
                                maximum: 52
                                minimum: 1
                                nullable: true
                                readOnly: false
                                type: integer
                              professionCode:
                                description: "A code field for a profession. This field only applies in case of a specific CLA (Bouw / Infra). Please leave empty if not applicable. NL: BeroepUWV"
                                example: 4
                                format: int32
                                maximum: 999
                                minimum: 1
                                nullable: true
                                readOnly: false
                                type: integer
                              sendToExternalParty:
                                description: "Indicates whether payroll information of this employment is sent to external pension funds. Attention: this indication ONLY applies regarding the information to pension funds. If NULL then setting according to regulation is leading. NL: AanleveringExternePartij"
                                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
                              signalPayGradeAdjustment:
                                description: "Indicates whether signaling regarding salary scale adjustments are enabled for the employment. NL: SalarisschaalSignaleren"
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              specialIncomeRatio:
                                description: "Indicates the special income ratio. NL: SpecialeInkomstenVerhouding"
                                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. NL: AanvangOpzegtermijn"
                                example: 2018-06-01
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              startDate:
                                description: "The date on which this employment starts. NL: DatumInDienst"
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              startDateContractOfIndefiniteDuration:
                                description: "When did the value of `employmentDurationType` change for definite to indefinite. NL: Startdatum onbepaalde tijd This value should be te samen as the `startDate` if the contract was indefinite from the start."
                                example: 2018-05-08
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              temporaryTaxExemption:
                                description: "Indicates whether there a temporary tax exemption is to be applied for the employment. NL: TijdelijkeHeffingskorting"
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Nee.
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              typeOfEmployee:
                                description: "A selection of pre defined employee-types for the employment. NL: SoortWerknemer"
                                format: metadata
                                nullable: false
                                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 (product required). NL: AardDeelnemerschap"
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 0
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: n.vt.
                                    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. NL: Vakantiebonnen"
                                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 (product required). NL: WaardeDeelnemerschap"
                                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
                              wachtgeldOldRegulation:
                                description: "Indicates whether the (old) wachtgeld regulation is applicable for the employment. NL: WachtgeldOudeRegeling"
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              writtenEmploymentContract:
                                description: "Did the employment and employer make a written contract? NL: Schriftelijke overeenkomst"
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of an employment
      tags:
        - Employment
  "/providers/employers/employees/employments/{employmentId}/abpfunds":
    get:
      description: |
        __Activity name :__ GetAbpFundsByEmploymentId

        Get a list of the abp funds the employment partakes in.
      operationId: GetAbpFundsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
              examples:
                example1:
                  value:
                    _embedded:
                      - deviations: null
                        endDate: 2018-10-23
                        fixedContribution: null
                        fund:
                          description: Ouderdomspensioen
                          key: 1
                        id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                        startDate: 2018-01-01
                    currentPage: 2
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    pageSize: 250
                    totalPages: 3
                    totalSize: 650
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
                example2:
                  value:
                    _embedded:
                      - deviations:
                          employmentContributionPercentage: "1.0000"
                          totalContributionPercentage: "12.0007"
                        endDate: 2018-10-23
                        fixedContribution: null
                        fund:
                          description: Ouderdomspensioen
                          key: 1
                        id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                        startDate: 2018-01-01
                    currentPage: 2
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    pageSize: 250
                    totalPages: 3
                    totalSize: 650
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
                example3:
                  value:
                    _embedded:
                      - deviations: null
                        endDate: 2018-10-23
                        fixedContribution:
                          employmentContribution: "1789.00"
                          totalContribution: "2569.00"
                        fund:
                          description: Ouderdomspensioen
                          key: 1
                        id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                        startDate: 2018-01-01
                    currentPage: 2
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    pageSize: 250
                    totalPages: 3
                    totalSize: 650
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            deviations:
                              description: |-
                                Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`.

                                Deviating is done on either all the fields or none.

                                __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                              nullable: true
                              properties:
                                employmentContributionPercentage:
                                  description: |-
                                    Deviating employment contribution percentage. This value will overrule the value of the selected `fund`. Indicates percentage wise how much the employment has to contribute to the payment of the "fund" contribution.

                                    __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                                  example: 11
                                  format: double
                                  maximum: 100
                                  minimum: 0
                                  nullable: false
                                  pattern: ^(\d{1,3})(\.\d{1,3})?$
                                  readOnly: false
                                  type: number
                                totalContributionPercentage:
                                  description: |-
                                    Deviating total contribution percentage. This value will overrule the value of the selected `fund`. The difference between `employmentContributionPercentage` and `totalContributionPercentage` will be paid by the employer.

                                    __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                                  example: 12.007
                                  format: double
                                  maximum: 100
                                  minimum: 0
                                  nullable: false
                                  pattern: ^(\d{1,3})(\.\d{1,3})?$
                                  readOnly: false
                                  type: number
                              readOnly: false
                              type: object
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              format: date
                              nullable: true
                              readOnly: false
                              type: string
                            fixedContribution:
                              description: |-
                                With the underlying elements fixed values (money) can be set as the result of the Fund calculation.  In doing so the actual calculation for the `fund` will no longer take place as the outcome is fixed. This has the side effect that the "grondslag" is no longer calculated.  In the data exchange with certain parties the "grondslag" has to be communicated allongside the contribution.  In those cases do not use this option as the calculation is disabled.

                                Setting a fixed contribution is done on either all the fields or none.

                                __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                              nullable: true
                              properties:
                                employmentContribution:
                                  description: |-
                                    The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates.

                                    __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0.00 up to 9999.99
                                  example: 1789
                                  format: double
                                  maximum: 99999999.99
                                  minimum: 0
                                  nullable: false
                                  pattern: ^(\d{1,8})(\.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                totalContribution:
                                  description: |-
                                    The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates.

                                    __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0 up to 9999.99
                                  example: 2569
                                  format: double
                                  maximum: 99999999.99
                                  minimum: 0
                                  nullable: false
                                  pattern: ^(\d{1,8})(\.\d{1,2})?$
                                  readOnly: false
                                  type: number
                              readOnly: false
                              type: object
                            fund:
                              format: metadata
                              properties:
                                description:
                                  description: |
                                    The description of the fund
                                  example: Ouderdomspensioen
                                  maxLength: 255
                                  minLength: 1
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  description: |
                                    The key for the fund
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              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
                            startDate:
                              description: |-
                                The date on which this fund starts.

                                A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time.
                              example: 2018-01-01
                              format: date
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 abp funds the employment partakes in
      tags:
        - Abp funds
    post:
      description: |-
        __Activity name :__ PostAbpFundByEmploymentId

        __Metadata :__ Possible options for fields of the type "metadata" can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults" to the POST URL.

        Activate an abp fund for an employment
      operationId: PostAbpFundByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
            examples:
              example1:
                value:
                  deviations: null
                  endDate: 2018-10-23
                  fixedContribution: null
                  fund:
                    key: 1
                  startDate: 2018-01-01
              example2:
                value:
                  deviations:
                    employmentContributionPercentage: "11.0000"
                    totalContributionPercentage: "12.0007"
                  endDate: 2018-10-23
                  fixedContribution: null
                  fund:
                    key: 1
                  startDate: 2018-01-01
              example3:
                value:
                  deviations: null
                  endDate: 2018-10-23
                  fixedContribution:
                    employmentContribution: "1789.00"
                    totalContribution: "2569.00"
                  fund:
                    key: 1
                  startDate: 2018-01-01
            schema:
              properties:
                deviations:
                  description: |-
                    Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`.

                    Deviating is done on either all the fields or none.

                    __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                  nullable: true
                  properties:
                    employmentContributionPercentage:
                      description: |-
                        Deviating employment contribution percentage. This value will overrule the value of the selected `fund`. Indicates percentage wise how much the employment has to contribute to the payment of the "fund" contribution.

                        __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                      example: 11
                      format: double
                      maximum: 100
                      minimum: 0
                      nullable: false
                      pattern: ^(\d{1,3})(\.\d{1,3})?$
                      readOnly: false
                      type: number
                    totalContributionPercentage:
                      description: |-
                        Deviating total contribution percentage. This value will overrule the value of the selected `fund`. The difference between `employmentContributionPercentage` and `totalContributionPercentage` will be paid by the employer.

                        __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                      example: 12.007
                      format: double
                      maximum: 100
                      minimum: 0
                      nullable: false
                      pattern: ^(\d{1,3})(\.\d{1,3})?$
                      readOnly: false
                      type: number
                  readOnly: false
                  type: object
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                fixedContribution:
                  description: |-
                    With the underlying elements fixed values (money) can be set as the result of the Fund calculation.  In doing so the actual calculation for the `fund` will no longer take place as the outcome is fixed. This has the side effect that the "grondslag" is no longer calculated.  In the data exchange with certain parties the "grondslag" has to be communicated allongside the contribution.  In those cases do not use this option as the calculation is disabled.

                    Setting a fixed contribution is done on either all the fields or none.

                    __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                  nullable: true
                  properties:
                    employmentContribution:
                      description: |-
                        The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates.

                        __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0.00 up to 9999.99
                      example: 1789
                      format: double
                      maximum: 99999999.99
                      minimum: 0
                      nullable: false
                      pattern: ^(\d{1,8})(\.\d{1,2})?$
                      readOnly: false
                      type: number
                    totalContribution:
                      description: |-
                        The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates.

                        __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0 up to 9999.99
                      example: 2569
                      format: double
                      maximum: 99999999.99
                      minimum: 0
                      nullable: false
                      pattern: ^(\d{1,8})(\.\d{1,2})?$
                      readOnly: false
                      type: number
                  readOnly: false
                  type: object
                fund:
                  format: metadata
                  properties:
                    description:
                      description: |
                        The description of the fund
                      example: Ouderdomspensioen
                      maxLength: 255
                      minLength: 1
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      description: |
                        The key for the fund
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  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
                startDate:
                  description: |-
                    The date on which this fund starts.

                    A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
        description: Add an abp fund for an employment.
        required: true
      responses:
        "201":
          content:
            application/json;version=2018-01-01:
              examples:
                example1:
                  value:
                    content:
                      deviations: null
                      endDate: 2018-10-23
                      fixedContribution: null
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
                example2:
                  value:
                    content:
                      deviations:
                        employmentContributionPercentage: "1.0000"
                        totalContributionPercentage: "12.0007"
                      endDate: 2018-10-23
                      fixedContribution: null
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
                example3:
                  value:
                    content:
                      deviations: null
                      endDate: 2018-10-23
                      fixedContribution:
                        employmentContribution: "1789.00"
                        totalContribution: "2569.00"
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          deviations:
                            description: |-
                              Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`.

                              Deviating is done on either all the fields or none.

                              __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                            nullable: true
                            properties:
                              employmentContributionPercentage:
                                description: |-
                                  Deviating employment contribution percentage. This value will overrule the value of the selected `fund`. Indicates percentage wise how much the employment has to contribute to the payment of the "fund" contribution.

                                  __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                                example: 11
                                format: double
                                maximum: 100
                                minimum: 0
                                nullable: false
                                pattern: ^(\d{1,3})(\.\d{1,3})?$
                                readOnly: false
                                type: number
                              totalContributionPercentage:
                                description: |-
                                  Deviating total contribution percentage. This value will overrule the value of the selected `fund`. The difference between `employmentContributionPercentage` and `totalContributionPercentage` will be paid by the employer.

                                  __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                                example: 12.007
                                format: double
                                maximum: 100
                                minimum: 0
                                nullable: false
                                pattern: ^(\d{1,3})(\.\d{1,3})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          fixedContribution:
                            description: |-
                              With the underlying elements fixed values (money) can be set as the result of the Fund calculation.  In doing so the actual calculation for the `fund` will no longer take place as the outcome is fixed. This has the side effect that the "grondslag" is no longer calculated.  In the data exchange with certain parties the "grondslag" has to be communicated allongside the contribution.  In those cases do not use this option as the calculation is disabled.

                              Setting a fixed contribution is done on either all the fields or none.

                              __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                            nullable: true
                            properties:
                              employmentContribution:
                                description: |-
                                  The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates.

                                  __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0.00 up to 9999.99
                                example: 1789
                                format: double
                                maximum: 99999999.99
                                minimum: 0
                                nullable: false
                                pattern: ^(\d{1,8})(\.\d{1,2})?$
                                readOnly: false
                                type: number
                              totalContribution:
                                description: |-
                                  The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates.

                                  __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0 up to 9999.99
                                example: 2569
                                format: double
                                maximum: 99999999.99
                                minimum: 0
                                nullable: false
                                pattern: ^(\d{1,8})(\.\d{1,2})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          fund:
                            format: metadata
                            properties:
                              description:
                                description: |
                                  The description of the fund
                                example: Ouderdomspensioen
                                maxLength: 255
                                minLength: 1
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                description: |
                                  The key for the fund
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            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
                          startDate:
                            description: |-
                              The date on which this fund starts.

                              A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Activate an abp fund for an employment
      tags:
        - Abp funds
  "/providers/employers/employees/employments/{employmentId}/attachmentsofearnings":
    get:
      description: |
        __Activity name :__ GetAttachmentOfEarningsByEmploymentId

        Get a list of attachment of earnings records
      operationId: GetAttachmentOfEarningsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            beneficiary:
                              description: Information regarding the beneficiary coresponding with the bank account number
                              nullable: false
                              properties:
                                city:
                                  description: |
                                    City name of beneficiary
                                  example: Rome
                                  maxLength: 24
                                  minLength: 1
                                  nullable: true
                                  readOnly: false
                                  type: string
                                name:
                                  description: |
                                    Name of the beneficiary
                                  example: Ben Hur
                                  maxLength: 70
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                              type: object
                            creditor:
                              description: Information regarding the creditor
                              nullable: false
                              properties:
                                priority:
                                  description: The priority of a creditor within the type of creditors. 0 is the highest priority followed by 1 etc. Priority dictates the order in which creditor receives their payment.  The amount of earnings that can be used for payments can be limited (see attachment-exempt threshold).  The system will then divide the available earnings starting with the creditor with the highest priority.  If all available earnings are spend all other attachments will not receive payment until the time that earnings are available to meet them.
                                  example: 0
                                  format: int32
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                type:
                                  description: The type of creditor. A preferent creditor has priority over non-preferent creditors.
                                  format: metadata
                                  properties:
                                    key:
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Preferente schuldeiser
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                              type: object
                            description1:
                              description: |
                                Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                              example: Savings to different account
                              maxLength: 32
                              minLength: 1
                              nullable: false
                              readOnly: false
                              type: string
                            description2:
                              description: |
                                Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                              example: from net wage
                              maxLength: 32
                              minLength: 1
                              nullable: true
                              readOnly: false
                              type: string
                            descriptionPayslip:
                              description: |
                                This value is shown on the payslip to identify the attachment.
                              example: payment to creditor x
                              maxLength: 14
                              minLength: 1
                              nullable: false
                              readOnly: false
                              type: string
                            endDate:
                              description: |
                                The end date of the record
                              example: 2018-10-23
                              format: date
                              nullable: true
                              readOnly: false
                              type: string
                            fixedPaymentPerPayrollPeriod:
                              description: |-
                                Set a fixed sum to be payed every payroll period.

                                __Note:__ If left empty the "available" earnings will be calculated in the payroll run by subtracting the protected earnings threshold (beslagvrijevoet) from the netwage. This method can lead to variable payments per payroll period.
                              example: 50
                              format: double
                              maximum: 99999999.99
                              minimum: 0.01
                              nullable: true
                              pattern: ^(\d{1,8})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            iban:
                              description: |
                                International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                              example: NL52ABNA0424968264
                              maxLength: 35
                              minLength: 1
                              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
                            startDate:
                              description: |
                                Start date of this record

                                __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for splitting from net salary at that date (based on the start- and enddate).
                              example: 2018-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            totalAmount:
                              properties:
                                owed:
                                  description: The total amount to be paid to the creditor
                                  example: 320
                                  format: double
                                  maximum: 99999999.99
                                  minimum: 0.01
                                  nullable: false
                                  pattern: ^(\d{1,8})(\.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                paid:
                                  properties:
                                    inApprovedPayrollRuns:
                                      description: The total amount registerd in payroll run(s) with the status "approved".
                                      example: 50
                                      format: double
                                      maximum: 99999999.99
                                      minimum: 0
                                      nullable: false
                                      pattern: ^(\d{1,8})(\.\d{1,2})?$
                                      readOnly: true
                                      type: number
                                    inOpenPayrollRun:
                                      description: |-
                                        The total amount registerd in payroll run(s) with the status "open". 

                                        Note that open payroll runs are not final until they get approved, changes are posible until then.
                                      example: 0
                                      format: double
                                      maximum: 99999999.99
                                      minimum: 0
                                      nullable: false
                                      pattern: ^(\d{1,8})(\.\d{1,2})?$
                                      readOnly: true
                                      type: number
                                  readOnly: true
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 attachment of earnings records
      tags:
        - Attachment of earnings
    post:
      description: |
        __Activity name :__ PostAttachmentOfEarningsByEmploymentId

        Create a new attachment of earnings record for an employment.

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

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostAttachmentOfEarningsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
          applicationjson;version=2018-01-01:
            schema:
              properties:
                beneficiary:
                  description: Information regarding the beneficiary coresponding with the bank account number
                  nullable: false
                  properties:
                    city:
                      description: |
                        City name of beneficiary
                      example: Rome
                      maxLength: 24
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                    name:
                      description: |
                        Name of the beneficiary
                      example: Ben Hur
                      maxLength: 70
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                  type: object
                creditor:
                  description: Information regarding the creditor
                  nullable: false
                  properties:
                    priority:
                      description: The priority of a creditor within the type of creditors. 0 is the highest priority followed by 1 etc. Priority dictates the order in which creditor receives their payment.  The amount of earnings that can be used for payments can be limited (see attachment-exempt threshold).  The system will then divide the available earnings starting with the creditor with the highest priority.  If all available earnings are spend all other attachments will not receive payment until the time that earnings are available to meet them.
                      example: 0
                      format: int32
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                    type:
                      description: The type of creditor. A preferent creditor has priority over non-preferent creditors.
                      format: metadata
                      properties:
                        key:
                          example: 1
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: Preferente schuldeiser
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                  type: object
                description1:
                  description: |
                    Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                  example: Savings to different account
                  maxLength: 32
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                description2:
                  description: |
                    Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                  example: from net wage
                  maxLength: 32
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                descriptionPayslip:
                  description: |
                    This value is shown on the payslip to identify the attachment.
                  example: payment to creditor x
                  maxLength: 14
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                endDate:
                  description: |
                    The end date of the record
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                fixedPaymentPerPayrollPeriod:
                  description: |-
                    Set a fixed sum to be payed every payroll period.

                    __Note:__ If left empty the "available" earnings will be calculated in the payroll run by subtracting the protected earnings threshold (beslagvrijevoet) from the netwage. This method can lead to variable payments per payroll period.
                  example: 50
                  format: double
                  maximum: 99999999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,8})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                iban:
                  description: |
                    International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                  example: NL52ABNA0424968264
                  maxLength: 35
                  minLength: 1
                  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
                startDate:
                  description: |
                    Start date of this record

                    __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for splitting from net salary at that date (based on the start- and enddate).
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                totalAmount:
                  properties:
                    owed:
                      description: The total amount to be paid to the creditor
                      example: 320
                      format: double
                      maximum: 99999999.99
                      minimum: 0.01
                      nullable: false
                      pattern: ^(\d{1,8})(\.\d{1,2})?$
                      readOnly: false
                      type: number
                    paid:
                      properties:
                        inApprovedPayrollRuns:
                          description: The total amount registerd in payroll run(s) with the status "approved".
                          example: 50
                          format: double
                          maximum: 99999999.99
                          minimum: 0
                          nullable: false
                          pattern: ^(\d{1,8})(\.\d{1,2})?$
                          readOnly: true
                          type: number
                        inOpenPayrollRun:
                          description: |-
                            The total amount registerd in payroll run(s) with the status "open". 

                            Note that open payroll runs are not final until they get approved, changes are posible until then.
                          example: 0
                          format: double
                          maximum: 99999999.99
                          minimum: 0
                          nullable: false
                          pattern: ^(\d{1,8})(\.\d{1,2})?$
                          readOnly: true
                          type: number
                      readOnly: true
                      type: object
                  type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          beneficiary:
                            description: Information regarding the beneficiary coresponding with the bank account number
                            nullable: false
                            properties:
                              city:
                                description: |
                                  City name of beneficiary
                                example: Rome
                                maxLength: 24
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              name:
                                description: |
                                  Name of the beneficiary
                                example: Ben Hur
                                maxLength: 70
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                            type: object
                          creditor:
                            description: Information regarding the creditor
                            nullable: false
                            properties:
                              priority:
                                description: The priority of a creditor within the type of creditors. 0 is the highest priority followed by 1 etc. Priority dictates the order in which creditor receives their payment.  The amount of earnings that can be used for payments can be limited (see attachment-exempt threshold).  The system will then divide the available earnings starting with the creditor with the highest priority.  If all available earnings are spend all other attachments will not receive payment until the time that earnings are available to meet them.
                                example: 0
                                format: int32
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                              type:
                                description: The type of creditor. A preferent creditor has priority over non-preferent creditors.
                                format: metadata
                                properties:
                                  key:
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Preferente schuldeiser
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                            type: object
                          description1:
                            description: |
                              Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: Savings to different account
                            maxLength: 32
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          description2:
                            description: |
                              Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: from net wage
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          descriptionPayslip:
                            description: |
                              This value is shown on the payslip to identify the attachment.
                            example: payment to creditor x
                            maxLength: 14
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          endDate:
                            description: |
                              The end date of the record
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          fixedPaymentPerPayrollPeriod:
                            description: |-
                              Set a fixed sum to be payed every payroll period.

                              __Note:__ If left empty the "available" earnings will be calculated in the payroll run by subtracting the protected earnings threshold (beslagvrijevoet) from the netwage. This method can lead to variable payments per payroll period.
                            example: 50
                            format: double
                            maximum: 99999999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,8})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          iban:
                            description: |
                              International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                            example: NL52ABNA0424968264
                            maxLength: 35
                            minLength: 1
                            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
                          startDate:
                            description: |
                              Start date of this record

                              __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for splitting from net salary at that date (based on the start- and enddate).
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          totalAmount:
                            properties:
                              owed:
                                description: The total amount to be paid to the creditor
                                example: 320
                                format: double
                                maximum: 99999999.99
                                minimum: 0.01
                                nullable: false
                                pattern: ^(\d{1,8})(\.\d{1,2})?$
                                readOnly: false
                                type: number
                              paid:
                                properties:
                                  inApprovedPayrollRuns:
                                    description: The total amount registerd in payroll run(s) with the status "approved".
                                    example: 50
                                    format: double
                                    maximum: 99999999.99
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,8})(\.\d{1,2})?$
                                    readOnly: true
                                    type: number
                                  inOpenPayrollRun:
                                    description: |-
                                      The total amount registerd in payroll run(s) with the status "open". 

                                      Note that open payroll runs are not final until they get approved, changes are posible until then.
                                    example: 0
                                    format: double
                                    maximum: 99999999.99
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,8})(\.\d{1,2})?$
                                    readOnly: true
                                    type: number
                                readOnly: true
                                type: object
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 new attachment of earnings record
      tags:
        - Attachment of earnings
  "/providers/employers/employees/employments/{employmentId}/basesforcalculation":
    get:
      description: |
        __Activity name :__ GetBasesForCalculationByEmploymentId

        Get a list of the bases (money) that are used as the base for certain calculations.
      operationId: GetBasesForCalculationByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - properties:
                                ageBasedMaximum:
                                  description: |
                                    This fields indicates how the age based maximum is applied
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      description: |
                                        The number for the ageBasedMaximum
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      description: |
                                        The description of the ageBasedMaximum
                                      example: Toepassen hoogste leeftijd
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                ageBasedMinimum:
                                  description: |
                                    This fields indicates how the age based minimum is applied
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      description: |
                                        The number for the ageBasedMinimum
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      description: |
                                        The description of the ageBasedMinimum
                                      example: Toepassen hoogste leeftijd
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                deviations:
                                  description: |-
                                    Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `base`. 
                                    Set `deviations` to null if no deviations apply.

                                    Deviating is done on either all the fields or none.
                                  nullable: true
                                  properties:
                                    financialReservationPercentage:
                                      description: deviation from the financial reservation percentage
                                      example: 10.000007
                                      format: double
                                      maximum: 999.999999
                                      minimum: 0
                                      nullable: false
                                      pattern: ^(\d{1,3})(\.\d{1,6})?$
                                      readOnly: false
                                      type: number
                                    percentage:
                                      description: Deviation from the percentage
                                      example: 8
                                      format: double
                                      maximum: 999.999999
                                      minimum: 0
                                      nullable: false
                                      pattern: ^(\d{1,3})(\.\d{1,6})?$
                                      readOnly: false
                                      type: number
                                    reservationPercentage:
                                      description: deviation from the reservation percentage
                                      example: 12.0007
                                      format: double
                                      maximum: 999.999999
                                      minimum: 0
                                      nullable: false
                                      pattern: ^(\d{1,3})(\.\d{1,6})?$
                                      readOnly: false
                                      type: number
                                  readOnly: false
                                  type: object
                                endDate:
                                  description: The end date of the entity. The date is up to and including.
                                  example: 2018-10-23
                                  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 on which this base starts.

                                    A (linked chain)[./#section/Data/Date-chains] per base is maintained within this resource.
                                    So multiple bases can be active at the same time but one specific base can never be active multiple times at the same time.
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: false
                                  type: string
                            - properties:
                                base:
                                  description: |
                                    `base` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      description: |
                                        The number for the base
                                      example: 545
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      description: |
                                        The description of the base
                                      example: VAKANTIE TOESLAG, periodieke opbouw
                                      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: 2018-12-31
                            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 <field>
                              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.
                                See [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 bases for employment fund calculations.
      tags:
        - Base for calculation
    post:
      description: |
        __Activity name :__ PostBaseForCalculationByEmploymentId

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults` to the POST URL.

        Add a base for calculation record.
      operationId: PostBaseFundCalculationByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                - properties:
                    ageBasedMaximum:
                      description: |
                        This fields indicates how the age based maximum is applied
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          description: |
                            The number for the ageBasedMaximum
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          description: |
                            The description of the ageBasedMaximum
                          example: Toepassen hoogste leeftijd
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    ageBasedMinimum:
                      description: |
                        This fields indicates how the age based minimum is applied
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          description: |
                            The number for the ageBasedMinimum
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          description: |
                            The description of the ageBasedMinimum
                          example: Toepassen hoogste leeftijd
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    deviations:
                      description: |-
                        Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `base`. 
                        Set `deviations` to null if no deviations apply.

                        Deviating is done on either all the fields or none.
                      nullable: true
                      properties:
                        financialReservationPercentage:
                          description: deviation from the financial reservation percentage
                          example: 10.000007
                          format: double
                          maximum: 999.999999
                          minimum: 0
                          nullable: false
                          pattern: ^(\d{1,3})(\.\d{1,6})?$
                          readOnly: false
                          type: number
                        percentage:
                          description: Deviation from the percentage
                          example: 8
                          format: double
                          maximum: 999.999999
                          minimum: 0
                          nullable: false
                          pattern: ^(\d{1,3})(\.\d{1,6})?$
                          readOnly: false
                          type: number
                        reservationPercentage:
                          description: deviation from the reservation percentage
                          example: 12.0007
                          format: double
                          maximum: 999.999999
                          minimum: 0
                          nullable: false
                          pattern: ^(\d{1,3})(\.\d{1,6})?$
                          readOnly: false
                          type: number
                      readOnly: false
                      type: object
                    endDate:
                      description: The end date of the entity. The date is up to and including.
                      example: 2018-10-23
                      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 on which this base starts.

                        A (linked chain)[./#section/Data/Date-chains] per base is maintained within this resource.
                        So multiple bases can be active at the same time but one specific base can never be active multiple times at the same time.
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: false
                      type: string
                - properties:
                    base:
                      description: |
                        `base` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          description: |
                            The number for the base
                          example: 545
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          description: |
                            The description of the base
                          example: VAKANTIE TOESLAG, periodieke opbouw
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        allOf:
                          - properties:
                              ageBasedMaximum:
                                description: |
                                  This fields indicates how the age based maximum is applied
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The number for the ageBasedMaximum
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: |
                                      The description of the ageBasedMaximum
                                    example: Toepassen hoogste leeftijd
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              ageBasedMinimum:
                                description: |
                                  This fields indicates how the age based minimum is applied
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The number for the ageBasedMinimum
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: |
                                      The description of the ageBasedMinimum
                                    example: Toepassen hoogste leeftijd
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              deviations:
                                description: |-
                                  Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `base`. 
                                  Set `deviations` to null if no deviations apply.

                                  Deviating is done on either all the fields or none.
                                nullable: true
                                properties:
                                  financialReservationPercentage:
                                    description: deviation from the financial reservation percentage
                                    example: 10.000007
                                    format: double
                                    maximum: 999.999999
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,3})(\.\d{1,6})?$
                                    readOnly: false
                                    type: number
                                  percentage:
                                    description: Deviation from the percentage
                                    example: 8
                                    format: double
                                    maximum: 999.999999
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,3})(\.\d{1,6})?$
                                    readOnly: false
                                    type: number
                                  reservationPercentage:
                                    description: deviation from the reservation percentage
                                    example: 12.0007
                                    format: double
                                    maximum: 999.999999
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,3})(\.\d{1,6})?$
                                    readOnly: false
                                    type: number
                                readOnly: false
                                type: object
                              endDate:
                                description: The end date of the entity. The date is up to and including.
                                example: 2018-10-23
                                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 on which this base starts.

                                  A (linked chain)[./#section/Data/Date-chains] per base is maintained within this resource.
                                  So multiple bases can be active at the same time but one specific base can never be active multiple times at the same time.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: false
                                type: string
                          - properties:
                              base:
                                description: |
                                  `base` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The number for the base
                                    example: 545
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: |
                                      The description of the base
                                    example: VAKANTIE TOESLAG, periodieke opbouw
                                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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 base for calculation
      tags:
        - Base for calculation
  "/providers/employers/employees/employments/{employmentId}/basesforemploymentfundcalculation":
    get:
      description: |
        __Activity name :__ GetBasesForEmploymentFundCalculationByEmploymentId

        Get a list of the bases (money) that are used in employment fund calculations.
      operationId: GetBasesForEmploymentFundCalculationByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - properties:
                                base:
                                  description: |
                                    The base (amount of money) to be used in the fund calculation
                                  example: 25000
                                  format: double
                                  maximum: 999999.99
                                  minimum: 0.01
                                  nullable: false
                                  pattern: ^(\d{1,6})(\.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                endDate:
                                  description: The end date of the entity. The date is up to and including.
                                  example: 2018-10-23
                                  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
                                origin:
                                  description: |
                                    Indicates the method by which the record was created/changed, its origin. The origin influences certain business processes. For example if a record exists with origin manually entered (Normale wijziging) the process that calculates the base automatically will not do so as a manually entered value allready exists.
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      description: |
                                        The number for the origin
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    value:
                                      description: |
                                        The description of the origin
                                      example: Normale wijziging
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                startDate:
                                  description: |-
                                    The date on which this base for calculation starts.

                                    A (linked chain)[./#section/Data/Date-chains] per base for calculation is maintained within this resource. So multiple bases can be active at the same time for different payrollcomponents
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: false
                                  type: string
                            - properties:
                                payrollComponent:
                                  description: |
                                    A payroll component is the link to the salary calculation. In this case only specific payrollcomponents are available. The payroll components that are reserved for use as the base for fund calculations

                                    `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: false
                                  properties:
                                    description:
                                      description: |
                                        The description of the payroll component
                                      example: JAAR GRSL3
                                      maxLength: 14
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      description: |
                                        The number for the payroll component.                      
                                      example: 545
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 bases for employment fund calculations.
      tags:
        - Base for employment fund calculation
    post:
      description: |
        __Activity name :__ PostBaseForEmploymentFundCalculationByEmploymentId

        __Metadata :__ Possible options for fields of the type "metadata" can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults" to the POST URL.

        Add a base for employment fund calculation.
      operationId: PostBaseForEmploymentFundCalculationByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                - properties:
                    base:
                      description: |
                        The base (amount of money) to be used in the fund calculation
                      example: 25000
                      format: double
                      maximum: 999999.99
                      minimum: 0.01
                      nullable: false
                      pattern: ^(\d{1,6})(\.\d{1,2})?$
                      readOnly: false
                      type: number
                    endDate:
                      description: The end date of the entity. The date is up to and including.
                      example: 2018-10-23
                      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
                    origin:
                      description: |
                        Indicates the method by which the record was created/changed, its origin. The origin influences certain business processes. For example if a record exists with origin manually entered (Normale wijziging) the process that calculates the base automatically will not do so as a manually entered value allready exists.
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          description: |
                            The number for the origin
                          example: 1
                          format: int32
                          nullable: false
                          readOnly: true
                          type: integer
                        value:
                          description: |
                            The description of the origin
                          example: Normale wijziging
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    startDate:
                      description: |-
                        The date on which this base for calculation starts.

                        A (linked chain)[./#section/Data/Date-chains] per base for calculation is maintained within this resource. So multiple bases can be active at the same time for different payrollcomponents
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: false
                      type: string
                - properties:
                    payrollComponent:
                      description: |
                        A payroll component is the link to the salary calculation. In this case only specific payrollcomponents are available. The payroll components that are reserved for use as the base for fund calculations

                        `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                      format: metadata
                      nullable: false
                      properties:
                        description:
                          description: |
                            The description of the payroll component
                          example: JAAR GRSL3
                          maxLength: 14
                          nullable: false
                          readOnly: true
                          type: string
                        key:
                          description: |
                            The number for the payroll component.                      
                          example: 545
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                      type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        allOf:
                          - properties:
                              base:
                                description: |
                                  The base (amount of money) to be used in the fund calculation
                                example: 25000
                                format: double
                                maximum: 999999.99
                                minimum: 0.01
                                nullable: false
                                pattern: ^(\d{1,6})(\.\d{1,2})?$
                                readOnly: false
                                type: number
                              endDate:
                                description: The end date of the entity. The date is up to and including.
                                example: 2018-10-23
                                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
                              origin:
                                description: |
                                  Indicates the method by which the record was created/changed, its origin. The origin influences certain business processes. For example if a record exists with origin manually entered (Normale wijziging) the process that calculates the base automatically will not do so as a manually entered value allready exists.
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The number for the origin
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  value:
                                    description: |
                                      The description of the origin
                                    example: Normale wijziging
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              startDate:
                                description: |-
                                  The date on which this base for calculation starts.

                                  A (linked chain)[./#section/Data/Date-chains] per base for calculation is maintained within this resource. So multiple bases can be active at the same time for different payrollcomponents
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: false
                                type: string
                          - properties:
                              payrollComponent:
                                description: |
                                  A payroll component is the link to the salary calculation. In this case only specific payrollcomponents are available. The payroll components that are reserved for use as the base for fund calculations

                                  `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                format: metadata
                                nullable: false
                                properties:
                                  description:
                                    description: |
                                      The description of the payroll component
                                    example: JAAR GRSL3
                                    maxLength: 14
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  key:
                                    description: |
                                      The number for the payroll component.                      
                                    example: 545
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                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: 2018-12-31
                            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 <field>
                              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.
                                See [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 base for employment fund calculation
      tags:
        - Base for employment fund calculation
  "/providers/employers/employees/employments/{employmentId}/benefitsInKind":
    get:
      description: |
        __Activity name:__ GetBenefitsInKindByEmploymentId
        Get a list of the Benefits in kind of the employment.
      operationId: GetBenefitsInKindByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            benefitInKindType:
                              description: The benefit in kind of the employment. `benefitinkind` is a metadata field within the employer context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                description:
                                  example: Mobiele telefoon
                                  nullable: false
                                  readOnly: true
                                  type: string
                                id:
                                  description: |
                                    The unique identifier of an object (GUID/UUID)
                                  example: 36530F13-59EB-4C15-B5F2-4F92B070A208
                                  format: uuid
                                  nullable: false
                                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                  readOnly: false
                                  type: string
                              type: object
                            brand:
                              description: The brand of the benefit in kind.
                              example: Apple
                              maxLength: 30
                              nullable: true
                              readOnly: false
                              type: string
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              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
                            particularities:
                              description: Extra information about the benefit in kind
                              example: geen bijzonderheden
                              maxLength: 4000
                              nullable: true
                              readOnly: false
                              type: string
                            startDate:
                              description: |
                                The date on which this BenefitInKind starts.

                                So multiple Benefits in kind can be active at the same time but one specific BenefitsInKind can never be active multiple times at the same time.
                              example: 2018-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            supplier:
                              description: The supplier of the benefit in kind.
                              example: Mediamarkt
                              maxLength: 30
                              nullable: true
                              readOnly: false
                              type: string
                            type:
                              description: The type of the benefit in kind.
                              example: Iphone 11
                              maxLength: 30
                              nullable: true
                              readOnly: false
                              type: string
                            value:
                              description: The value for the selected benefit of kind.
                              example: 1100
                              minimum: 0
                              nullable: false
                              pattern: ^(\d{1,5})(\.\d{1,2})?$
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 Benefits in kind
      tags:
        - Benefit in kind
    post:
      description: |
        __Activity name :__ PostBenefitInKindByEmploymentId

        __Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.

        __Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostBenefitInKindByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                benefitInKindType:
                  description: The benefit in kind of the employment. `benefitinkind` is a metadata field within the employer context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    description:
                      example: Mobiele telefoon
                      nullable: false
                      readOnly: true
                      type: string
                    id:
                      description: |
                        The unique identifier of an object (GUID/UUID)
                      example: 36530F13-59EB-4C15-B5F2-4F92B070A208
                      format: uuid
                      nullable: false
                      pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                      readOnly: false
                      type: string
                  type: object
                brand:
                  description: The brand of the benefit in kind.
                  example: Apple
                  maxLength: 30
                  nullable: true
                  readOnly: false
                  type: string
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  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
                particularities:
                  description: Extra information about the benefit in kind
                  example: geen bijzonderheden
                  maxLength: 4000
                  nullable: true
                  readOnly: false
                  type: string
                startDate:
                  description: |
                    The date on which this BenefitInKind starts.

                    So multiple Benefits in kind can be active at the same time but one specific BenefitsInKind can never be active multiple times at the same time.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                supplier:
                  description: The supplier of the benefit in kind.
                  example: Mediamarkt
                  maxLength: 30
                  nullable: true
                  readOnly: false
                  type: string
                type:
                  description: The type of the benefit in kind.
                  example: Iphone 11
                  maxLength: 30
                  nullable: true
                  readOnly: false
                  type: string
                value:
                  description: The value for the selected benefit of kind.
                  example: 1100
                  minimum: 0
                  nullable: false
                  pattern: ^(\d{1,5})(\.\d{1,2})?$
                  readOnly: false
                  type: number
        description: Add a benefit in kind
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          benefitInKindType:
                            description: The benefit in kind of the employment. `benefitinkind` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Mobiele telefoon
                                nullable: false
                                readOnly: true
                                type: string
                              id:
                                description: |
                                  The unique identifier of an object (GUID/UUID)
                                example: 36530F13-59EB-4C15-B5F2-4F92B070A208
                                format: uuid
                                nullable: false
                                pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                readOnly: false
                                type: string
                            type: object
                          brand:
                            description: The brand of the benefit in kind.
                            example: Apple
                            maxLength: 30
                            nullable: true
                            readOnly: false
                            type: string
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            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
                          particularities:
                            description: Extra information about the benefit in kind
                            example: geen bijzonderheden
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          startDate:
                            description: |
                              The date on which this BenefitInKind starts.

                              So multiple Benefits in kind can be active at the same time but one specific BenefitsInKind can never be active multiple times at the same time.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          supplier:
                            description: The supplier of the benefit in kind.
                            example: Mediamarkt
                            maxLength: 30
                            nullable: true
                            readOnly: false
                            type: string
                          type:
                            description: The type of the benefit in kind.
                            example: Iphone 11
                            maxLength: 30
                            nullable: true
                            readOnly: false
                            type: string
                          value:
                            description: The value for the selected benefit of kind.
                            example: 1100
                            minimum: 0
                            nullable: false
                            pattern: ^(\d{1,5})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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 Benefit in kind for an employment
      tags:
        - Benefit in kind
  "/providers/employers/employees/employments/{employmentId}/benefitsanddeductions":
    get:
      description: |
        __Activity name :__ GetBenefitsAndDeductionsByEmploymentId

        Get a list of benefits and deductions for the employment
      operationId: GetBenefitsAndDeductionsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            endDate:
                              description: |
                                The end date for the information in the record.
                              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
                            payrollComponent:
                              description: |
                                A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                                `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                category:
                                  description: |
                                    The category of the payroll component. There are six viable categories for this resource: <br/> 7,  Bruto vergoeding volgens tabel<br/> 9,  Netto vergoeding<br/> 30, Bedrag per eenheid<br/> 12, Bruto inhouding<br/> 13, Netto inhouding<br/> 11, Fiscale bijtelling <br/> 17, Afdrachtvermindering<br/>
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    value:
                                      example: Uren
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                deductionOrPayment:
                                  description: |
                                    Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    value:
                                      example: Betaling
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                description:
                                  description: |
                                    The description of the payroll component
                                  example: Uren gewerkt
                                  maxLength: 14
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  description: |
                                    The number for the payroll component.
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              readOnly: true
                              type: object
                            startDate:
                              description: |
                                The start date for the information in the record.

                                A (linked chain)[./#section/Data/Date-chains] per payroll component is maintained within this resource.
                              example: 1995-05-21
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            value:
                              description: |
                                The value for the selected payroll component.    <br/>
                              example: 50.87
                              maximum: 99999.99
                              minimum: 0.01
                              nullable: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 benefits and deductions
      tags:
        - Benefits and deductions
    post:
      description: |
        __Activity name :__ PostBenefitsAndDeductionsByEmploymentId

        Add a benefit or deduction for the employment

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults` to the POST URL.
      operationId: PostbenefitsAndDeductionsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                endDate:
                  description: |
                    The end date for the information in the record.
                  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
                payrollComponent:
                  description: |
                    A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                    `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    category:
                      description: |
                        The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          example: 1
                          format: int32
                          nullable: false
                          readOnly: true
                          type: integer
                        value:
                          example: Uren
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    deductionOrPayment:
                      description: |
                        Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: true
                          type: integer
                        value:
                          example: Betaling
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    description:
                      description: |
                        The description of the payroll component
                      example: Uren gewerkt
                      maxLength: 14
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      description: |
                        The number for the payroll component.
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
                startDate:
                  description: |
                    The start date for the information in the record.

                    A (linked chain)[./#section/Data/Date-chains] per payroll component is maintained with this resource.
                  example: 1995-05-21
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                value:
                  description: |
                    The value for the selected payroll component.
                  example: 50.87
                  maximum: 99999.99
                  minimum: 0.01
                  nullable: false
                  readOnly: false
                  type: number
        description: benefits and deductions record add to the employment.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          endDate:
                            description: |
                              The end date for the information in the record.
                            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
                          payrollComponent:
                            description: |
                              A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                              `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              category:
                                description: |
                                  The category of the payroll component. There are six viable categories for this resource: <br/> 7,  Bruto vergoeding volgens tabel<br/> 9,  Netto vergoeding<br/> 30, Bedrag per eenheid<br/> 12, Bruto inhouding<br/> 13, Netto inhouding<br/> 11, Fiscale bijtelling <br/> 17, Afdrachtvermindering<br/>
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  value:
                                    example: Uren
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              deductionOrPayment:
                                description: |
                                  Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  value:
                                    example: Betaling
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              description:
                                description: |
                                  The description of the payroll component
                                example: Uren gewerkt
                                maxLength: 14
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                description: |
                                  The number for the payroll component.
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            readOnly: true
                            type: object
                          startDate:
                            description: |
                              The start date for the information in the record.

                              A (linked chain)[./#section/Data/Date-chains] per payroll component is maintained within this resource.
                            example: 1995-05-21
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          value:
                            description: |
                              The value for the selected payroll component.    <br/>
                            example: 50.87
                            maximum: 99999.99
                            minimum: 0.01
                            nullable: false
                            readOnly: false
                            type: number
                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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 benefit or deduction record for the employment
      tags:
        - Benefits and deductions
  "/providers/employers/employees/employments/{employmentId}/companycars":
    get:
      description: |
        __Activity name:__ GetCompanyCarsByEmploymentId
            

        Get the list of company cars for an employment. 

        Please note this resource is related for the registration of the company car for HRM purposes. This resource is NOT related to the registration of the fiscal company car(s) which is used in salary calculations.
      operationId: GetCompanyCarsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: true
                          properties:
                            brand:
                              description: |
                                Brand of the vehicle.
                              example: Volvo
                              maximum: 25
                              nullable: true
                              readOnly: false
                              type: string
                            catalogValue:
                              description: |
                                The catalog value of the car.
                              example: 20000
                              format: double
                              maximum: 999999.99
                              nullable: true
                              pattern: ^(\d{1,6})(.\d{1,2})?$
                              readOnly: false
                              type: number
                            comments:
                              description: |
                                Any comments on the car or the contract.
                              example: This car is very nice
                              maximum: 4000
                              nullable: true
                              readOnly: false
                              type: string
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2023-10-23
                              format: date
                              nullable: true
                              readOnly: false
                              type: string
                            fuelCardNumber:
                              description: |
                                Registration number of the fuel card.
                              example: B100.323.903
                              maximum: 20
                              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
                            kilometersPrivateUse:
                              description: |
                                The number kilometers per year the employee can use the car for private purposes.
                              example: 10000
                              format: int32
                              nullable: true
                              readOnly: false
                              type: integer
                            lease:
                              description: |
                                Details of the leasecontract
                              nullable: true
                              properties:
                                contractNumber:
                                  description: |
                                    Registration number of the lease contract.
                                  example: 2021.323.903
                                  maximum: 20
                                  nullable: true
                                  readOnly: false
                                  type: string
                                endDate:
                                  description: The end date of the entity. The date is up to and including.
                                  example: 2023-10-23
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                startDate:
                                  description: The start date of the entity.
                                  example: 2021-01-01
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                              type: object
                            leaseOrBuy:
                              description: |
                                Indication of the ownership of the company car.
                              format: metaData
                              nullable: false
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Koop
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            licensePlateNumber:
                              description: |
                                Vehicle registration number (license plate) of the  company car. The number should be provided with or without any hyphens (-).
                              example: GP586D
                              maxLength: 8
                              minLength: 1
                              nullable: false
                              readOnly: false
                              type: string
                            model:
                              description: |
                                Model of the vehicle.
                              example: V60
                              maximum: 25
                              nullable: true
                              readOnly: false
                              type: string
                            startDate:
                              description: The start date of the entity.
                              example: 2021-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            supplier:
                              description: |
                                Name of the company the delivered the company car.
                              example: Leasemaatschappij Tilburg
                              maximum: 30
                              nullable: true
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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  company cars for an employment
      tags:
        - Company car
    post:
      description: |
        __Activity name:__ PostCompanyCarByEmploymentId
            

        Create a company car record for an employment.

        Please note this resource is related for the registration of the company car for HRM purposes. This resource is NOT related to the registration of the fiscal company car(s) which is used in salary calculations.

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ There are no defaults available.
      operationId: PostCompanyCarByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                brand:
                  description: |
                    Brand of the vehicle.
                  example: Volvo
                  maximum: 25
                  nullable: true
                  readOnly: false
                  type: string
                catalogValue:
                  description: |
                    The catalog value of the car.
                  example: 20000
                  format: double
                  maximum: 999999.99
                  nullable: true
                  pattern: ^(\d{1,6})(.\d{1,2})?$
                  readOnly: false
                  type: number
                comments:
                  description: |
                    Any comments on the car or the contract.
                  example: This car is very nice
                  maximum: 4000
                  nullable: true
                  readOnly: false
                  type: string
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2023-10-23
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                fuelCardNumber:
                  description: |
                    Registration number of the fuel card.
                  example: B100.323.903
                  maximum: 20
                  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
                kilometersPrivateUse:
                  description: |
                    The number kilometers per year the employee can use the car for private purposes.
                  example: 10000
                  format: int32
                  nullable: true
                  readOnly: false
                  type: integer
                lease:
                  description: |
                    Details of the leasecontract
                  nullable: true
                  properties:
                    contractNumber:
                      description: |
                        Registration number of the lease contract.
                      example: 2021.323.903
                      maximum: 20
                      nullable: true
                      readOnly: false
                      type: string
                    endDate:
                      description: The end date of the entity. The date is up to and including.
                      example: 2023-10-23
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    startDate:
                      description: The start date of the entity.
                      example: 2021-01-01
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                  type: object
                leaseOrBuy:
                  description: |
                    Indication of the ownership of the company car.
                  format: metaData
                  nullable: false
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Koop
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                licensePlateNumber:
                  description: |
                    Vehicle registration number (license plate) of the  company car. The number should be provided with or without any hyphens (-).
                  example: GP586D
                  maxLength: 8
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                model:
                  description: |
                    Model of the vehicle.
                  example: V60
                  maximum: 25
                  nullable: true
                  readOnly: false
                  type: string
                startDate:
                  description: The start date of the entity.
                  example: 2021-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                supplier:
                  description: |
                    Name of the company the delivered the company car.
                  example: Leasemaatschappij Tilburg
                  maximum: 30
                  nullable: true
                  readOnly: false
                  type: string
              type: object
        description: Company Car record to add to the employment.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          brand:
                            description: |
                              Brand of the vehicle.
                            example: Volvo
                            maximum: 25
                            nullable: true
                            readOnly: false
                            type: string
                          catalogValue:
                            description: |
                              The catalog value of the car.
                            example: 20000
                            format: double
                            maximum: 999999.99
                            nullable: true
                            pattern: ^(\d{1,6})(.\d{1,2})?$
                            readOnly: false
                            type: number
                          comments:
                            description: |
                              Any comments on the car or the contract.
                            example: This car is very nice
                            maximum: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2023-10-23
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          fuelCardNumber:
                            description: |
                              Registration number of the fuel card.
                            example: B100.323.903
                            maximum: 20
                            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
                          kilometersPrivateUse:
                            description: |
                              The number kilometers per year the employee can use the car for private purposes.
                            example: 10000
                            format: int32
                            nullable: true
                            readOnly: false
                            type: integer
                          lease:
                            description: |
                              Details of the leasecontract
                            nullable: true
                            properties:
                              contractNumber:
                                description: |
                                  Registration number of the lease contract.
                                example: 2021.323.903
                                maximum: 20
                                nullable: true
                                readOnly: false
                                type: string
                              endDate:
                                description: The end date of the entity. The date is up to and including.
                                example: 2023-10-23
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              startDate:
                                description: The start date of the entity.
                                example: 2021-01-01
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                            type: object
                          leaseOrBuy:
                            description: |
                              Indication of the ownership of the company car.
                            format: metaData
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Koop
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          licensePlateNumber:
                            description: |
                              Vehicle registration number (license plate) of the  company car. The number should be provided with or without any hyphens (-).
                            example: GP586D
                            maxLength: 8
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          model:
                            description: |
                              Model of the vehicle.
                            example: V60
                            maximum: 25
                            nullable: true
                            readOnly: false
                            type: string
                          startDate:
                            description: The start date of the entity.
                            example: 2021-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          supplier:
                            description: |
                              Name of the company the delivered the company car.
                            example: Leasemaatschappij Tilburg
                            maximum: 30
                            nullable: true
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 company car record for an employment
      tags:
        - Company car
  "/providers/employers/employees/employments/{employmentId}/correctstartdate":
    patch:
      description: |
        __Activity name :__ PatchCorrectStartDateByEmploymentId

        Edit the starting date (i.e. the official first day of a contract) of an employment. Please note that changing the starting data for an employment affects multiple entities in Loket (e.g. wage-records etc). 


         * With a correction of the starting date, you are responsible for the associated notifications. 
      operationId: PatchCorrectStartDateByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                startDate:
                  description: |
                    The date on which this employment starts (=first day of the employment).
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
        description: The request body contains an object containing fields related to termination of an employment.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Correct the start (employment) date for an employment.
      tags:
        - Employment
  "/providers/employers/employees/employments/{employmentId}/costperhour":
    get:
      description: |
        __Activity name:__ GetCostPerHourByEmploymentId
            

        Get the list of costs per hour for an employment
      operationId: GetCostPerHourByEmploymentId
      parameters:
        - description: include an estimation if no cost per unit records are present
          example: true
          in: query
          name: includeEstimation
          required: false
          schema:
            type: boolean
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: false
                          properties:
                            costPerHour:
                              description: |
                                The cost per hour for the employment
                              example: 21.2
                              format: double
                              maximum: 99999.99
                              minimum: -99999.99
                              nullable: false
                              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
                            payrollPeriods:
                              description: The period of the kpu record.
                              properties:
                                endDate:
                                  description: The last day of the payroll period
                                  example: 2020-01-31
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                id:
                                  description: The id for this specific payroll period.
                                  example: 202001
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                periodNumber:
                                  description: The period number of the payroll period
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                startDate:
                                  description: The first day of the payroll period
                                  example: 2020-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                year:
                                  description: The payroll year
                                  example: 2020
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              type: object
                            registrationMethod:
                              description: This object indicates how the cost per hour was aquired. Possible values are Verloning, Schatting and Handmatig
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: "The key of the registrationmethod ('Wijze van aanmaken'). "
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  description: The description of registrationmethod ('Wijze van aanmaken'). Possible values are "Verloning", "Schatting" and "Handmatig"
                                  example: Verloning
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 costs per hour for an employment
      tags:
        - Cost per hour
    post:
      description: |
        __Activity name :__ PostCostPerHourByEmploymentId

        __Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.

        __Defaults:__ Defaults can be acquired(GET)by adding `/defaults` to the POST URL.
      operationId: PostCostPerHourByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: false
              properties:
                costPerHour:
                  description: |
                    The cost per hour for the employment
                  example: 21.2
                  format: double
                  maximum: 99999.99
                  minimum: -99999.99
                  nullable: false
                  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
                payrollPeriods:
                  description: The period of the kpu record.
                  properties:
                    endDate:
                      description: The last day of the payroll period
                      example: 2020-01-31
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    id:
                      description: The id for this specific payroll period.
                      example: 202001
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    periodNumber:
                      description: The period number of the payroll period
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    startDate:
                      description: The first day of the payroll period
                      example: 2020-01-01
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    year:
                      description: The payroll year
                      example: 2020
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                  type: object
                registrationMethod:
                  description: This object indicates how the cost per hour was aquired. Possible values are Verloning, Schatting and Handmatig
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      description: "The key of the registrationmethod ('Wijze van aanmaken'). "
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    value:
                      description: The description of registrationmethod ('Wijze van aanmaken'). Possible values are "Verloning", "Schatting" and "Handmatig"
                      example: Verloning
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
              type: object
        description: Add a cost per hour
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          costPerHour:
                            description: |
                              The cost per hour for the employment
                            example: 21.2
                            format: double
                            maximum: 99999.99
                            minimum: -99999.99
                            nullable: false
                            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
                          payrollPeriods:
                            description: The period of the kpu record.
                            properties:
                              endDate:
                                description: The last day of the payroll period
                                example: 2020-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              id:
                                description: The id for this specific payroll period.
                                example: 202001
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              periodNumber:
                                description: The period number of the payroll period
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              startDate:
                                description: The first day of the payroll period
                                example: 2020-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: The payroll year
                                example: 2020
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                            type: object
                          registrationMethod:
                            description: This object indicates how the cost per hour was aquired. Possible values are Verloning, Schatting and Handmatig
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: "The key of the registrationmethod ('Wijze van aanmaken'). "
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                description: The description of registrationmethod ('Wijze van aanmaken'). Possible values are "Verloning", "Schatting" and "Handmatig"
                                example: Verloning
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 cost per hour for an employment
      tags:
        - Cost per hour
  "/providers/employers/employees/employments/{employmentId}/customfields":
    get:
      description: |
        __Activity name :__ GetEmploymentCustomFieldsByEmploymentId

        Get a list of the custom fields for an employment.

        __Note:__ custom fields are user defined at the employer level.
      operationId: GetEmploymentCustomFieldssByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            customField:
                              description: |
                                The custom field as defined at the employer-level.  The value can only be set in the POST (it cannot be changed with a PUT).
                              format: metadata
                              nullable: false
                              properties:
                                description:
                                  example: Shoe size
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                                id:
                                  description: The unique identifier of the custom field as defined at the employer level
                                  example: 025ce09b-bff2-4b05-bcf0-711a89da7c08
                                  format: uuid
                                  nullable: false
                                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                  readOnly: false
                                  type: string
                              readOnly: true
                              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
                            value:
                              description: The value for the custom field for the employment
                              example: "41"
                              maxLength: 255
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employment custom fields for an employment
      tags:
        - Employment custom field
    post:
      description: |
        __Activity name :__ PostEmploymentCustomFieldByEmploymentId

        __Metadata:__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.
      operationId: PostEmploymentCustomFieldByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                customField:
                  description: |
                    The custom field as defined at the employer-level.  The value can only be set in the POST (it cannot be changed with a PUT).
                  format: metadata
                  nullable: false
                  properties:
                    description:
                      example: Shoe size
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                    id:
                      description: The unique identifier of the custom field as defined at the employer level
                      example: 025ce09b-bff2-4b05-bcf0-711a89da7c08
                      format: uuid
                      nullable: false
                      pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                      readOnly: false
                      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
                value:
                  description: The value for the custom field for the employment
                  example: "41"
                  maxLength: 255
                  nullable: false
                  readOnly: false
                  type: string
        description: Add a custom field
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          customField:
                            description: |
                              The custom field as defined at the employer-level.  The value can only be set in the POST (it cannot be changed with a PUT).
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Shoe size
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                              id:
                                description: The unique identifier of the custom field as defined at the employer level
                                example: 025ce09b-bff2-4b05-bcf0-711a89da7c08
                                format: uuid
                                nullable: false
                                pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                readOnly: false
                                type: string
                            readOnly: true
                            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
                          value:
                            description: The value for the custom field for the employment
                            example: "41"
                            maxLength: 255
                            nullable: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 an employment custom field for an employment
      tags:
        - Employment custom field
  "/providers/employers/employees/employments/{employmentId}/customnotifications":
    get:
      description: |
        __Activity name :__ GetCustomNotificationsByEmploymentId
        Get a list of the custom notifications of the employment.
        __Note:__ custom notifications are user defined for a specific employment.
      operationId: GetCustomNotificationsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            expirationDate:
                              description: The date on which the Notification will expire.
                              example: 2021-01-23
                              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
                            notificationDate:
                              description: The date on which the first notification occurs.
                              example: 2021-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            notificationText:
                              description: The description of the signal
                              example: Signal renew document
                              nullable: false
                              readOnly: false
                              type: string
                            recurrencePattern:
                              description: |
                                Define a pattern for repeating the notification. This pattern is used to create Notifications after the initial notification as defined in the notificationDate.
                              format: metadata
                              nullable: true
                              properties:
                                numberOfRepetitionsAfterFirstNotification:
                                  description: |
                                    The number of times the notification will be repeated after the first Notification. Setting the value 99 will result in repeating the notification indefinite.
                                  example: 4
                                  format: int32
                                  maximum: 99
                                  minimum: 1
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                recurrenceNumber:
                                  description: |
                                    The number of the recurrence pattern. An example recurrence pattern is: repeat every 2 weeks.
                                  example: 2
                                  format: int32
                                  maximum: 365
                                  minimum: 1
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                recurrencePeriod:
                                  description: |
                                    The period of the recurrence pattern An example recurrence pattern is: repeat every 2 weeks.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Weeks
                                      maxLength: 50
                                      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: 2018-12-31
                            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 <field>
                              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.
                                See [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 custom notification
      tags:
        - Custom notification
    post:
      description: |
        __Activity name :__ PostCustomNotificationByEmploymentId

        __Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.

        __Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostCustomNotificationByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                expirationDate:
                  description: The date on which the Notification will expire.
                  example: 2021-01-23
                  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
                notificationDate:
                  description: The date on which the first notification occurs.
                  example: 2021-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                notificationText:
                  description: The description of the signal
                  example: Signal renew document
                  nullable: false
                  readOnly: false
                  type: string
                recurrencePattern:
                  description: |
                    Define a pattern for repeating the notification. This pattern is used to create Notifications after the initial notification as defined in the notificationDate.
                  format: metadata
                  nullable: true
                  properties:
                    numberOfRepetitionsAfterFirstNotification:
                      description: |
                        The number of times the notification will be repeated after the first Notification. Setting the value 99 will result in repeating the notification indefinite.
                      example: 4
                      format: int32
                      maximum: 99
                      minimum: 1
                      nullable: false
                      readOnly: false
                      type: integer
                    recurrenceNumber:
                      description: |
                        The number of the recurrence pattern. An example recurrence pattern is: repeat every 2 weeks.
                      example: 2
                      format: int32
                      maximum: 365
                      minimum: 1
                      nullable: false
                      readOnly: false
                      type: integer
                    recurrencePeriod:
                      description: |
                        The period of the recurrence pattern An example recurrence pattern is: repeat every 2 weeks.
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: Weeks
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                  type: object
        description: Add a custom notification
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          expirationDate:
                            description: The date on which the Notification will expire.
                            example: 2021-01-23
                            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
                          notificationDate:
                            description: The date on which the first notification occurs.
                            example: 2021-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          notificationText:
                            description: The description of the signal
                            example: Signal renew document
                            nullable: false
                            readOnly: false
                            type: string
                          recurrencePattern:
                            description: |
                              Define a pattern for repeating the notification. This pattern is used to create Notifications after the initial notification as defined in the notificationDate.
                            format: metadata
                            nullable: true
                            properties:
                              numberOfRepetitionsAfterFirstNotification:
                                description: |
                                  The number of times the notification will be repeated after the first Notification. Setting the value 99 will result in repeating the notification indefinite.
                                example: 4
                                format: int32
                                maximum: 99
                                minimum: 1
                                nullable: false
                                readOnly: false
                                type: integer
                              recurrenceNumber:
                                description: |
                                  The number of the recurrence pattern. An example recurrence pattern is: repeat every 2 weeks.
                                example: 2
                                format: int32
                                maximum: 365
                                minimum: 1
                                nullable: false
                                readOnly: false
                                type: integer
                              recurrencePeriod:
                                description: |
                                  The period of the recurrence pattern An example recurrence pattern is: repeat every 2 weeks.
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Weeks
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 custom notification for an employment
      tags:
        - Custom notification
  "/providers/employers/employees/employments/{employmentId}/declarations":
    get:
      description: |
        __Activity name :__ GetDeclarationsByEmploymentId

        Returns a list of declarations for the employments of the employer
      operationId: GetDeclarationsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            dateOfLastChangeByEmployee:
                              description: The time the declaration was last changed
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            dateOfSubmissionByEmployee:
                              description: The time the declaration was submitted
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            declarationComment:
                              description: The comment left by the employee
                              example: Overwerk project X
                              maxLength: 4000
                              nullable: true
                              readOnly: true
                              type: string
                            declarationDate:
                              description: The date to which the declaration is applicable. As requested by the employee.
                              example: 2017-11-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            declarationStatus:
                              description: |-
                                The current status of the declaration

                                The status is changed by using the PATCH endpoint.
                                1 Open --> Accept or reject 2 Goedgekeurd ---> Process (not yet implemented) 3 Geweigerd ---> No changes possible 5 Verwerkt ---> No changes possible 6 Onverwerkbaar ---> No changes possible
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Open
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              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
                            numberOfUnits:
                              description: The number of units requested
                              example: 8
                              format: double
                              nullable: false
                              pattern: ^(\d{1,3})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            payrollComponent:
                              description: |
                                A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment for the given payroll period. 
                              format: metadata
                              properties:
                                description:
                                  description: |
                                    The description of the payroll component
                                  example: Tijd voor tijd, UREN TVT 130%
                                  maxLength: 14
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  description: |
                                    The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know it by heart.
                                  example: 11
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            processedInPayrollPeriod:
                              description: |
                                If the declaration has been succesfully processed then this object will show the payroll period for which a payrollPeriodData has been created.

                                If the declaration has not yet been processed, then the value of this object will be null.
                              format: metadata
                              nullable: true
                              properties:
                                periodEndDate:
                                  description: |
                                    The last day of the period
                                  example: 2018-01-31
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                periodNumber:
                                  description: |
                                    The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period
                                  example: 1
                                  format: int32
                                  maximum: 53
                                  minimum: 1
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                periodStartDate:
                                  description: |
                                    The first day of the period
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                year:
                                  description: |
                                    The year of the payroll period
                                  example: 2017
                                  format: int32
                                  maximum: 9999
                                  minimum: 2000
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 declarations for an employment
      tags:
        - Declarations
  "/providers/employers/employees/employments/{employmentId}/deviatingawfcontributions":
    get:
      description: |
        __Activity name:__ GetDeviatingAwfContributionsByEmploymentId
        Get the list of Deviating AWF contributions records for an employment
      operationId: GetDeviatingAwfContributionByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: false
                          properties:
                            endPeriod:
                              format: metadata
                              nullable: true
                              properties:
                                periodEndDate:
                                  description: |
                                    The last day of the payroll period.
                                  example: 2018-01-31
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                periodNumber:
                                  description: |
                                    The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                  example: 1
                                  format: int32
                                  maximum: 53
                                  minimum: 1
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                periodStartDate:
                                  description: |
                                    The first day of the payroll period.
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                year:
                                  description: |
                                    The year of the last payroll period for which the record is applicable.
                                  example: 2017
                                  format: int32
                                  maximum: 9999
                                  minimum: 2000
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              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
                            startPeriod:
                              format: metadata
                              nullable: false
                              properties:
                                periodEndDate:
                                  description: |
                                    The last day of the payroll period.
                                  example: 2018-01-31
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                periodNumber:
                                  description: |
                                    The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the record is applicable.
                                  example: 1
                                  format: int32
                                  maximum: 53
                                  minimum: 1
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                periodStartDate:
                                  description: |
                                    The first day of the payroll period.
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                year:
                                  description: |
                                    The year of the first payroll period for which the record is applicable.
                                  example: 2017
                                  format: int32
                                  maximum: 9999
                                  minimum: 2000
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            typeOfDeviatingAwfContribution:
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: The type of deviating Deviating AWF contribution to be applied for this employment.
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: Description of the nationality
                                  example: Hoog
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 Deviating AWF contributions records for an employment
      tags:
        - Deviating AWF Contribution
    post:
      description: |
        __Activity name:__ PostDeviatingAwfContributionByEmploymentId
        Create a Deviating AWF contributions record for an employment

        __Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.

        __Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostDeviatingAwfContributionByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: false
              properties:
                endPeriod:
                  format: metadata
                  nullable: true
                  properties:
                    periodEndDate:
                      description: |
                        The last day of the payroll period.
                      example: 2018-01-31
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    periodNumber:
                      description: |
                        The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                      example: 1
                      format: int32
                      maximum: 53
                      minimum: 1
                      nullable: false
                      readOnly: false
                      type: integer
                    periodStartDate:
                      description: |
                        The first day of the payroll period.
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    year:
                      description: |
                        The year of the last payroll period for which the record is applicable.
                      example: 2017
                      format: int32
                      maximum: 9999
                      minimum: 2000
                      nullable: false
                      readOnly: false
                      type: integer
                  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
                startPeriod:
                  format: metadata
                  nullable: false
                  properties:
                    periodEndDate:
                      description: |
                        The last day of the payroll period.
                      example: 2018-01-31
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    periodNumber:
                      description: |
                        The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the record is applicable.
                      example: 1
                      format: int32
                      maximum: 53
                      minimum: 1
                      nullable: false
                      readOnly: false
                      type: integer
                    periodStartDate:
                      description: |
                        The first day of the payroll period.
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    year:
                      description: |
                        The year of the first payroll period for which the record is applicable.
                      example: 2017
                      format: int32
                      maximum: 9999
                      minimum: 2000
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
                typeOfDeviatingAwfContribution:
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      description: The type of deviating Deviating AWF contribution to be applied for this employment.
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: Description of the nationality
                      example: Hoog
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
              type: object
        description: Deviating AWF Contribution record to add to the employment.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          endPeriod:
                            format: metadata
                            nullable: true
                            properties:
                              periodEndDate:
                                description: |
                                  The last day of the payroll period.
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: |
                                  The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                example: 1
                                format: int32
                                maximum: 53
                                minimum: 1
                                nullable: false
                                readOnly: false
                                type: integer
                              periodStartDate:
                                description: |
                                  The first day of the payroll period.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: |
                                  The year of the last payroll period for which the record is applicable.
                                example: 2017
                                format: int32
                                maximum: 9999
                                minimum: 2000
                                nullable: false
                                readOnly: false
                                type: integer
                            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
                          startPeriod:
                            format: metadata
                            nullable: false
                            properties:
                              periodEndDate:
                                description: |
                                  The last day of the payroll period.
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: |
                                  The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the record is applicable.
                                example: 1
                                format: int32
                                maximum: 53
                                minimum: 1
                                nullable: false
                                readOnly: false
                                type: integer
                              periodStartDate:
                                description: |
                                  The first day of the payroll period.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: |
                                  The year of the first payroll period for which the record is applicable.
                                example: 2017
                                format: int32
                                maximum: 9999
                                minimum: 2000
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          typeOfDeviatingAwfContribution:
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: The type of deviating Deviating AWF contribution to be applied for this employment.
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: Description of the nationality
                                example: Hoog
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 Deviating AWF contributions record for an employment
      tags:
        - Deviating AWF Contribution
  "/providers/employers/employees/employments/{employmentId}/deviatinghourlywages":
    get:
      description: |
        __Activity name :__ GetDeviatingHourlyWagesByEmploymentId

        Get a list of the deviating hourly wages of the employment.

        __Note:__ Loket.nl has different ways to register deviating hourly wage. 
      operationId: GetDeviatingHourlyWagesByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              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
                            payrollComponent:
                              description: |
                                A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                                `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                description:
                                  description: |
                                    The description of the payroll component
                                  example: LOON/SALARIS
                                  maxLength: 14
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  description: |
                                    The number for the payroll component.
                                  example: 70
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            startDate:
                              description: |-
                                The date on which this DeviatingHouryWage starts.

                                A (broken chain)[./#section/Data/Date-chains] per DeviatingHouryWage is maintained within this resource. So multiple DeviatingHouryWages can be active at the same time but one specific DeviatingHouryWage can never be active multiple times at the same time.
                              example: 2018-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            value:
                              description: |
                                The value for the selected payroll component.
                              example: 50.87
                              maximum: 99999.99
                              minimum: 0.01
                              nullable: false
                              pattern: ^(\d{1,5})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 deviating hourly wage
      tags:
        - Deviating hourly wage
    post:
      description: |
        __Activity name :__ PostDeviatingHourlyWageByEmploymentId __Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL. __Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostDeviatingHourlyWageByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  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
                payrollComponent:
                  description: |
                    A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                    `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    description:
                      description: |
                        The description of the payroll component
                      example: LOON/SALARIS
                      maxLength: 14
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      description: |
                        The number for the payroll component.
                      example: 70
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
                startDate:
                  description: |-
                    The date on which this DeviatingHouryWage starts.

                    A (broken chain)[./#section/Data/Date-chains] per DeviatingHouryWage is maintained within this resource. So multiple DeviatingHouryWages can be active at the same time but one specific DeviatingHouryWage can never be active multiple times at the same time.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                value:
                  description: |
                    The value for the selected payroll component.
                  example: 50.87
                  maximum: 99999.99
                  minimum: 0.01
                  nullable: false
                  pattern: ^(\d{1,5})(\.\d{1,2})?$
                  readOnly: false
                  type: number
              type: object
        description: Add a deviating hourly wage
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            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
                          payrollComponent:
                            description: |
                              A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                              `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                description: |
                                  The description of the payroll component
                                example: LOON/SALARIS
                                maxLength: 14
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                description: |
                                  The number for the payroll component.
                                example: 70
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          startDate:
                            description: |-
                              The date on which this DeviatingHouryWage starts.

                              A (broken chain)[./#section/Data/Date-chains] per DeviatingHouryWage is maintained within this resource. So multiple DeviatingHouryWages can be active at the same time but one specific DeviatingHouryWage can never be active multiple times at the same time.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          value:
                            description: |
                              The value for the selected payroll component.
                            example: 50.87
                            maximum: 99999.99
                            minimum: 0.01
                            nullable: false
                            pattern: ^(\d{1,5})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 deviating hourly wage for an employment
      tags:
        - Deviating hourly wage
  "/providers/employers/employees/employments/{employmentId}/documents":
    get:
      description: |
        __Activity name :__ GetDocumentsByEmploymentId

        Get a list of documents within the employee's employment dossier (werknemerdossier). Via Qwoater.
      operationId: GetDocumentsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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
                                      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
                                      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
                                      example: 2018-05-08
                                      format: date
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    dateOfSubmission:
                                      description: |
                                        The time at which document was submitted. Qwoater: CreationDate
                                      example: 2018-05-08
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    description:
                                      description: |
                                        The description defined by the submitter. Qwoater: Docfield 33 Omschrijving
                                      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
                                      example: Bowls, John
                                      maxLength: 4000
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    year:
                                      description: |
                                        The year the document relates to. Qwoater: Docfield 86 Jaar
                                      example: 2017
                                      format: int32
                                      maximum: 9999
                                      minimum: 1000
                                      nullable: true
                                      readOnly: false
                                      type: integer
                                - properties:
                                    filename:
                                      description: |
                                        The name of the file. Qwoater: Filename
                                      example: BowlsJohn.pdf
                                      maxLength: 255
                                      minLength: 1
                                      nullable: false
                                      readOnly: false
                                      type: string
                            - properties:
                                isInitiateSignDocumentRequestPossible:
                                  description: |
                                    Indicates whether initiate sign document request is possible.
                                  example: true
                                  nullable: true
                                  readOnly: true
                                  type: boolean
                                signDocumentStatus:
                                  description: |
                                    Status of the signature.
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employment dossier documents
      tags:
        - Employment dossier
    post:
      description: |
        __Activity name :__ PostDocumentByEmploymentId

        __Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.

        Upload a document within the employee's employment dossier (werknemerdossier). Via Qwoater.
      operationId: PostDocumentByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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
                          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
                          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
                          example: 2018-05-08
                          format: date
                          nullable: true
                          readOnly: false
                          type: string
                        dateOfSubmission:
                          description: |
                            The time at which document was submitted. Qwoater: CreationDate
                          example: 2018-05-08
                          format: date
                          nullable: false
                          readOnly: true
                          type: string
                        description:
                          description: |
                            The description defined by the submitter. Qwoater: Docfield 33 Omschrijving
                          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
                          example: Bowls, John
                          maxLength: 4000
                          nullable: true
                          readOnly: true
                          type: string
                        year:
                          description: |
                            The year the document relates to. Qwoater: Docfield 86 Jaar
                          example: 2017
                          format: int32
                          maximum: 9999
                          minimum: 1000
                          nullable: true
                          readOnly: false
                          type: integer
                    - properties:
                        filename:
                          description: |
                            The name of the file. Qwoater: Filename
                          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
                    sendEmailNotification:
                      default: false
                      description: Indicate whether to send an email to the employee.
                      example: true
                      nullable: true
                      readOnly: false
                      type: boolean
        description: Document to be uploaded for the employment.
        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employment dossier
      tags:
        - Employment dossier
  "/providers/employers/employees/employments/{employmentId}/documents/{documentId}":
    delete:
      description: |
        __Activity name:__ DeleteDocumentByEmploymentIdAndDocumentId

        Delete a document in the employment dossier
      operationId: DeleteDocumentByEmploymentIdAndDocumentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employment dossier
      tags:
        - Employment dossier
    get:
      description: |
        __Activity name :__ GetDocumentByEmploymentIdAndDocumentId

        Download the file of a given employment dossier entry. Via Qwoater.
      operationId: GetDocumentByEmploymentIdAndDocumentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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 employment dossier document
      tags:
        - Employment dossier
    put:
      description: |
        __Activity name:__ PutDocumentByEmploymentIdAndDocumentId

        Edit the details for a document in the employment dossier
      operationId: PutDocumentByEmploymentIdAndDocumentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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
                  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
                  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
                  example: 2018-05-08
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                dateOfSubmission:
                  description: |
                    The time at which document was submitted. Qwoater: CreationDate
                  example: 2018-05-08
                  format: date
                  nullable: false
                  readOnly: true
                  type: string
                description:
                  description: |
                    The description defined by the submitter. Qwoater: Docfield 33 Omschrijving
                  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
                  example: Bowls, John
                  maxLength: 4000
                  nullable: true
                  readOnly: true
                  type: string
                year:
                  description: |
                    The year the document relates to. Qwoater: Docfield 86 Jaar
                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of an employment dossier document
      tags:
        - Employment dossier
  "/providers/employers/employees/employments/{employmentId}/documents/{documentId}/audittrail":
    get:
      description: |
        __Activity name :__ GetAuditTrailByEmploymentIdAndDocumentId

        Get audittrail for the document in the employment dossier.
      operationId: GetAuditTrailByEmploymentIdAndDocumentId
      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 employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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
                              example: ""
                              nullable: true
                              readOnly: true
                              type: string
                            category:
                              description: |
                                Qwoater: DocumentType
                              example: ""
                              nullable: true
                              readOnly: true
                              type: string
                            dateOfAlert:
                              description: |
                                The time the declaration was submitted. Qwoater: Signaleringsdatum
                              example: 2018-05-08
                              format: date
                              nullable: true
                              readOnly: true
                              type: string
                            description:
                              description: |
                                Qwoater: Omschrijving
                              example: VSP004
                              nullable: true
                              readOnly: true
                              type: string
                            endUser:
                              description: |
                                Qwoater: EndUser
                              example: Hur, Ben
                              nullable: true
                              readOnly: true
                              type: string
                            event:
                              description: |
                                Qwoater: Event
                              example: Audittrail opgevraagd
                              nullable: false
                              readOnly: true
                              type: string
                            eventDate:
                              description: |
                                The time the declaration was submitted. Qwoater: AuditEventDate
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            role:
                              description: |
                                Qwoater: Role
                              example: Provider
                              nullable: false
                              readOnly: true
                              type: string
                            year:
                              description: |
                                Qwoater: Jaar
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employment dossier
      tags:
        - Employment dossier
  "/providers/employers/employees/employments/{employmentId}/documents/{documentId}/signature":
    delete:
      description: |
        __Activity name :__ DeleteSignatureByEmploymentIdAndDocumentId

        __Metadata:__ No metadata available.

        Delete the proces to sign a document for an employment.
      operationId: DeleteSignatureByEmploymentIdAndDocumentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 - Employment
      tags:
        - Sign document
    get:
      description: |
        __Activity name :__ GetSignatureByEmploymentIdAndDocumentId

        __Metadata:__ No metadata available.

        Retrieve the status of the signing.
      operationId: GetSignatureByEmploymentIdAndDocumentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: <some warning>
                              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.
                                See [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: 2021-02-24T08:20:33.105668Z
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 - Employment
      tags:
        - Sign document
  "/providers/employers/employees/employments/{employmentId}/documents/{documentId}/signature/initiate":
    post:
      description: |
        __Activity name :__ PostInitiateSignatureByEmploymentIdAndDocumentId

        __Metadata:__ No metadata available. Defaults are available by adding /defaults to the path.

        Initiate the proces to sign a document for an employment by one or more signers.
      operationId: PostInitiateSignatureByEmploymentIdAndDocumentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 - Employment
      tags:
        - Sign document
  "/providers/employers/employees/employments/{employmentId}/documents/{documentId}/signature/report":
    get:
      description: |
        __Activity name :__ GetSignatureReportByEmploymentIdAndDocumentId

        __Metadata:__ No metadata available.

        Report of the signature.
      operationId: GetSignatureReportByEmploymentIdAndDocumentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 - Employment
      tags:
        - Sign document
  "/providers/employers/employees/employments/{employmentId}/documenttemplates/{documentId}/generatedocument":
    post:
      description: |
        __Activity name :__ PostGenerateDocumentByEmploymentIdAndDocumentId

        __Metadata:__ Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).

        Generate a document for an employment and store it in the employment dossier. Via Qwoater.
      operationId: PostGenerateDocumentByEmploymentIdAndDocumentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                - properties:
                    attribute:
                      description: |
                        The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk
                      example: VSP004
                      maxLength: 250
                      nullable: true
                      readOnly: false
                      type: string
                    dateOfAlert:
                      description: |
                        The date at which document will alerted for cancellation. Qwoater: AlertDate
                      example: 2018-05-08
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    description:
                      description: |
                        The description defined by the submitter. Qwoater: Docfield 33 Omschrijving
                      example: Copy of id card
                      maxLength: 250
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    filename:
                      description: |
                        The name of the file. Qwoater: Filename
                      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.
                      example: 2020-05-08
                      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
                      example: 2017
                      format: int32
                      maximum: 9999
                      minimum: 1000
                      nullable: true
                      readOnly: false
                      type: integer
                - properties:
                    sendEmailNotification:
                      default: false
                      description: Indicate whether to send an email to the employee.
                      example: true
                      nullable: true
                      readOnly: false
                      type: boolean
        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employment
      tags:
        - Generate document
  "/providers/employers/employees/employments/{employmentId}/documenttemplates/{documentId}/generatedocument/preview":
    post:
      description: |
        __Activity name :__ PostGenerateDocumentPreviewByEmploymentIdAndDocumentId

        __Metadata:__ Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).

        Generate a document for an employment and receive a preview. Via Qwoater.
      operationId: PostGenerateDocumentPreviewByEmploymentIdAndDocumentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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
                  example: VSP004
                  maxLength: 250
                  nullable: true
                  readOnly: false
                  type: string
                dateOfAlert:
                  description: |
                    The date at which document will alerted for cancellation. Qwoater: AlertDate
                  example: 2018-05-08
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                description:
                  description: |
                    The description defined by the submitter. Qwoater: Docfield 33 Omschrijving
                  example: Copy of id card
                  maxLength: 250
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                filename:
                  description: |
                    The name of the file. Qwoater: Filename
                  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.
                  example: 2020-05-08
                  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
                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employment - preview
      tags:
        - Generate document
  "/providers/employers/employees/employments/{employmentId}/employeeprofile":
    patch:
      description: |
        __Activity name :__ PatchEmployeeProfileByEmploymentId

        Create Fondsen, Grondslagen and toeslagen based on the employment's employeeProfile.
      operationId: PatchEmployeeProfileByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: false
              properties:
                activationDate:
                  description: The date on which the profile should be activated.
                  example: 2021-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                employeeProfileId:
                  description: The Id of the employeeProfile. If not provided, the employeeProfile which is set at employment level, is used.
                  example: 1
                  format: int32
                  nullable: true
                  readOnly: false
                  type: integer
              type: object
      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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          basesForCalculation:
                            items:
                              description: The ID's of the created entities
                              example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                              format: uuid
                              type: string
                            type: array
                          benefitsAndDeductions:
                            items:
                              description: The ID's of the created entities
                              example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                              format: uuid
                              type: string
                            type: array
                          employmentFunds:
                            items:
                              description: The ID's of the created entities
                              example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                              format: uuid
                              type: string
                            type: array
                          employmentFundsABP:
                            items:
                              description: The ID's of the created entities
                              example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                              format: uuid
                              type: string
                            type: array
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Activate employee profile for the employment
      tags:
        - Activate employee profile
  "/providers/employers/employees/employments/{employmentId}/employmentfunds":
    get:
      description: |
        __Activity name :__ GetEmploymentFundsByEmploymentId

        Get a list of the funds the employment partakes in.
      operationId: GetEmploymentFundsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
              examples:
                example1:
                  value:
                    _embedded:
                      - deviations: null
                        endDate: 2018-10-23
                        fixedContribution: null
                        fund:
                          description: Ouderdomspensioen
                          key: 1
                        id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                        startDate: 2018-01-01
                    currentPage: 2
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    pageSize: 250
                    totalPages: 3
                    totalSize: 650
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
                example2:
                  value:
                    _embedded:
                      - deviations:
                          employmentContributionPercentage: "1.0000"
                          totalContributionPercentage: "12.0007"
                        endDate: 2018-10-23
                        fixedContribution: null
                        fund:
                          description: Ouderdomspensioen
                          key: 1
                        id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                        startDate: 2018-01-01
                    currentPage: 2
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    pageSize: 250
                    totalPages: 3
                    totalSize: 650
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
                example3:
                  value:
                    _embedded:
                      - deviations: null
                        endDate: 2018-10-23
                        fixedContribution:
                          employmentContribution: "1789.00"
                          totalContribution: "2569.00"
                        fund:
                          description: Ouderdomspensioen
                          key: 1
                        id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                        startDate: 2018-01-01
                    currentPage: 2
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    pageSize: 250
                    totalPages: 3
                    totalSize: 650
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            deviations:
                              description: |-
                                Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`.

                                Deviating is done on either all the fields or none.

                                __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                              nullable: true
                              properties:
                                employmentContributionPercentage:
                                  description: |-
                                    Deviating employment contribution percentage. This value will overrule the value of the selected `fund`. Indicates percentage wise how much the employment has to contribute to the payment of the "fund" contribution.

                                    __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                                  example: 11
                                  format: double
                                  maximum: 100
                                  minimum: 0
                                  nullable: false
                                  pattern: ^(\d{1,3})(\.\d{1,4})?$
                                  readOnly: false
                                  type: number
                                totalContributionPercentage:
                                  description: |-
                                    Deviating total contribution percentage. This value will overrule the value of the selected `fund`. The difference between `employmentContributionPercentage` and `totalContributionPercentage` will be paid by the employer.

                                    __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                                  example: 12.0007
                                  format: double
                                  maximum: 100
                                  minimum: 0
                                  nullable: false
                                  pattern: ^(\d{1,3})(\.\d{1,4})?$
                                  readOnly: false
                                  type: number
                              readOnly: false
                              type: object
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              format: date
                              nullable: true
                              readOnly: false
                              type: string
                            fixedContribution:
                              description: |-
                                With the underlying elements fixed values (money) can be set as the result of the Fund calculation.  In doing so the actual calculation for the `fund` will no longer take place as the outcome is fixed. This has the side effect that the "grondslag" is no longer calculated.  In the data exchange with certain parties the "grondslag" has to be communicated allongside the contribution.  In those cases do not use this option as the calculation is disabled.

                                Setting a fixed contribution is done on either all the fields or none.

                                __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                              nullable: true
                              properties:
                                employmentContribution:
                                  description: |-
                                    The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates.

                                    __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0.00 up to 9999.99
                                  example: 1789
                                  format: double
                                  maximum: 99999999.99
                                  minimum: 0
                                  nullable: false
                                  pattern: ^(\d{1,8})(\.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                totalContribution:
                                  description: |-
                                    The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates.

                                    __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0 up to 9999.99
                                  example: 2569
                                  format: double
                                  maximum: 99999999.99
                                  minimum: 0
                                  nullable: false
                                  pattern: ^(\d{1,8})(\.\d{1,2})?$
                                  readOnly: false
                                  type: number
                              readOnly: false
                              type: object
                            fund:
                              format: metadata
                              properties:
                                description:
                                  description: |
                                    The description of the fund
                                  example: Ouderdomspensioen
                                  maxLength: 255
                                  minLength: 1
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  description: |
                                    The key for the fund
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              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
                            startDate:
                              description: |-
                                The date on which this fund starts.

                                A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time.
                              example: 2018-01-01
                              format: date
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 funds the employment partakes in
      tags:
        - Employment funds
    post:
      description: |-
        __Activity name :__ PostEmploymentFundByEmploymentId

        __Metadata :__ Possible options for fields of the type "metadata" can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults" to the POST URL.

        Activate a fund for an employment
      operationId: PostEmploymentFundByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
            examples:
              example1:
                value:
                  deviations: null
                  endDate: 2018-10-23
                  fixedContribution: null
                  fund:
                    key: 1
                  startDate: 2018-01-01
              example2:
                value:
                  deviations:
                    employmentContributionPercentage: "11.0000"
                    totalContributionPercentage: "12.0007"
                  endDate: 2018-10-23
                  fixedContribution: null
                  fund:
                    key: 1
                  startDate: 2018-01-01
              example3:
                value:
                  deviations: null
                  endDate: 2018-10-23
                  fixedContribution:
                    employmentContribution: "1789.00"
                    totalContribution: "2569.00"
                  fund:
                    key: 1
                  startDate: 2018-01-01
            schema:
              properties:
                deviations:
                  description: |-
                    Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`.

                    Deviating is done on either all the fields or none.

                    __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                  nullable: true
                  properties:
                    employmentContributionPercentage:
                      description: |-
                        Deviating employment contribution percentage. This value will overrule the value of the selected `fund`. Indicates percentage wise how much the employment has to contribute to the payment of the "fund" contribution.

                        __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                      example: 11
                      format: double
                      maximum: 100
                      minimum: 0
                      nullable: false
                      pattern: ^(\d{1,3})(\.\d{1,4})?$
                      readOnly: false
                      type: number
                    totalContributionPercentage:
                      description: |-
                        Deviating total contribution percentage. This value will overrule the value of the selected `fund`. The difference between `employmentContributionPercentage` and `totalContributionPercentage` will be paid by the employer.

                        __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                      example: 12.0007
                      format: double
                      maximum: 100
                      minimum: 0
                      nullable: false
                      pattern: ^(\d{1,3})(\.\d{1,4})?$
                      readOnly: false
                      type: number
                  readOnly: false
                  type: object
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                fixedContribution:
                  description: |-
                    With the underlying elements fixed values (money) can be set as the result of the Fund calculation.  In doing so the actual calculation for the `fund` will no longer take place as the outcome is fixed. This has the side effect that the "grondslag" is no longer calculated.  In the data exchange with certain parties the "grondslag" has to be communicated allongside the contribution.  In those cases do not use this option as the calculation is disabled.

                    Setting a fixed contribution is done on either all the fields or none.

                    __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                  nullable: true
                  properties:
                    employmentContribution:
                      description: |-
                        The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates.

                        __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0.00 up to 9999.99
                      example: 1789
                      format: double
                      maximum: 99999999.99
                      minimum: 0
                      nullable: false
                      pattern: ^(\d{1,8})(\.\d{1,2})?$
                      readOnly: false
                      type: number
                    totalContribution:
                      description: |-
                        The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates.

                        __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0 up to 9999.99
                      example: 2569
                      format: double
                      maximum: 99999999.99
                      minimum: 0
                      nullable: false
                      pattern: ^(\d{1,8})(\.\d{1,2})?$
                      readOnly: false
                      type: number
                  readOnly: false
                  type: object
                fund:
                  format: metadata
                  properties:
                    description:
                      description: |
                        The description of the fund
                      example: Ouderdomspensioen
                      maxLength: 255
                      minLength: 1
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      description: |
                        The key for the fund
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  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
                startDate:
                  description: |-
                    The date on which this fund starts.

                    A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
        description: Add a fund for an employment.
        required: true
      responses:
        "201":
          content:
            application/json;version=2018-01-01:
              examples:
                example1:
                  value:
                    content:
                      deviations: null
                      endDate: 2018-10-23
                      fixedContribution: null
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
                example2:
                  value:
                    content:
                      deviations:
                        employmentContributionPercentage: "1.0000"
                        totalContributionPercentage: "12.0007"
                      endDate: 2018-10-23
                      fixedContribution: null
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
                example3:
                  value:
                    content:
                      deviations: null
                      endDate: 2018-10-23
                      fixedContribution:
                        employmentContribution: "1789.00"
                        totalContribution: "2569.00"
                      fund:
                        description: Ouderdomspensioen
                        key: 1
                      id: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      startDate: 2018-01-01
                    messages:
                      - code: 12
                        description: <some warning>
                        id: string
                        properties:
                          - string
                        type: Warning
                    version:
                      obsoleteDate: null
                      resourceVersion: 2018-12-31
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          deviations:
                            description: |-
                              Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`.

                              Deviating is done on either all the fields or none.

                              __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                            nullable: true
                            properties:
                              employmentContributionPercentage:
                                description: |-
                                  Deviating employment contribution percentage. This value will overrule the value of the selected `fund`. Indicates percentage wise how much the employment has to contribute to the payment of the "fund" contribution.

                                  __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                                example: 11
                                format: double
                                maximum: 100
                                minimum: 0
                                nullable: false
                                pattern: ^(\d{1,3})(\.\d{1,4})?$
                                readOnly: false
                                type: number
                              totalContributionPercentage:
                                description: |-
                                  Deviating total contribution percentage. This value will overrule the value of the selected `fund`. The difference between `employmentContributionPercentage` and `totalContributionPercentage` will be paid by the employer.

                                  __Note:__ Records with a `startDate` before 1-1-2014 have a different regular expression__:__ ^(\d{1,3})(\.\d{1,3})?$ (a scale of 3 instead of 4).
                                example: 12.0007
                                format: double
                                maximum: 100
                                minimum: 0
                                nullable: false
                                pattern: ^(\d{1,3})(\.\d{1,4})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          fixedContribution:
                            description: |-
                              With the underlying elements fixed values (money) can be set as the result of the Fund calculation.  In doing so the actual calculation for the `fund` will no longer take place as the outcome is fixed. This has the side effect that the "grondslag" is no longer calculated.  In the data exchange with certain parties the "grondslag" has to be communicated allongside the contribution.  In those cases do not use this option as the calculation is disabled.

                              Setting a fixed contribution is done on either all the fields or none.

                              __Note:__ `deviations` and `fixedContribution` are mutually exclusive.
                            nullable: true
                            properties:
                              employmentContribution:
                                description: |-
                                  The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates.

                                  __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0.00 up to 9999.99
                                example: 1789
                                format: double
                                maximum: 99999999.99
                                minimum: 0
                                nullable: false
                                pattern: ^(\d{1,8})(\.\d{1,2})?$
                                readOnly: false
                                type: number
                              totalContribution:
                                description: |-
                                  The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates.

                                  __Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0 up to 9999.99
                                example: 2569
                                format: double
                                maximum: 99999999.99
                                minimum: 0
                                nullable: false
                                pattern: ^(\d{1,8})(\.\d{1,2})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          fund:
                            format: metadata
                            properties:
                              description:
                                description: |
                                  The description of the fund
                                example: Ouderdomspensioen
                                maxLength: 255
                                minLength: 1
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                description: |
                                  The key for the fund
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            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
                          startDate:
                            description: |-
                              The date on which this fund starts.

                              A (linked chain)[./#section/Data/Date-chains] per fund is maintained within this resource. So multiple funds can be active at the same time but one specific fund can never be active multiple times at the same time.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Activate a fund for an employment
      tags:
        - Employment funds
  "/providers/employers/employees/employments/{employmentId}/fiscalcompanycars":
    get:
      description: |
        __Activity name:__ GetFiscalCompanyCarsByEmploymentId
            

        Get the list of fiscal company cars for an employment. 

        Please note this resource is related for the registration of the company car for tax purposes. This is NOT directly related to the registration of the company car(s) related to the HRM-module 'Verstrekking'
      operationId: GetFiscalCompanyCarsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: true
                          properties:
                            additionalTaxLiabilityGroup:
                              description: |
                                Indication for what additional tax liability percentage (bijtelling) should be used for calculating the tax liabiltiy in the payroll process.

                                It is possible to acquire a value for this field based on the RDW-registration of the vehicle registration number (license plate) by calling that supplementary endpoint.
                              format: metaData
                              nullable: false
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Standaard tarief (25% tot 2017)
                                  maxLength: 100
                                  minLength: 0
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            dateOfFirstAdmission:
                              description: First day of admission for the vehicle (datum eerste toelating). It is possible to acquire a value for this field based on the RDW-registration by calling that supplementary endpoint.
                              example: 2018-01-01
                              format: date
                              nullable: true
                              readOnly: false
                              type: string
                            deviatingAdditionalTaxLiability:
                              description: |
                                Normally Loket will calculate the applicable tax liability based on the value and tax liability group of the car. However this field may OVERRIDE any other values, and in that case this amount will be applied as the applicable tax liability amount.
                              example: 20000
                              format: double
                              maximum: 999999.99
                              minimum: 0.01
                              nullable: true
                              pattern: ^(\d{1,6})(.\d{1,2})?$
                              readOnly: false
                              type: number
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2023-10-23
                              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
                            licensePlateNumber:
                              description: |
                                Vehicle registration number (license plate) of the fiscal company car. The number should be provided with or without any hyphens (-).
                              example: GP586D
                              maxLength: 15
                              minLength: 0
                              nullable: true
                              readOnly: false
                              type: string
                            reasonForNoAdditionalTaxLiability:
                              description: |
                                In case the employment does have a fiscal company car but no additional tax liability should be applied, then the reason should be provided for the payroll tax return.
                              format: metaData
                              nullable: true
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: (2) Werknemer heeft beschikking belastingdienst
                                  maxLength: 50
                                  minLength: 0
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            startDate:
                              description: |-
                                The start date of the entity.

                                A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                              example: 2021-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            taxableBenefitForPrivateUse:
                              description: |
                                Taxable benefit for private use (eigen bijdrage van de werknemer) may be entered here, this will lower the tax liability to be paid in the payrolling process.
                              example: 2000
                              format: double
                              maximum: 999999.99
                              minimum: 0.01
                              nullable: true
                              pattern: ^(\d{1,6})(.\d{1,2})?$
                              readOnly: false
                              type: number
                            valueForTaxPurposes:
                              description: |
                                The value of the car for tax purposes. This field may only be NULL if a reason for no additional tax liability (reden voor geen bijtelling) is provided.
                                It is possible to acquire a value for this field based on the RDW-registration by calling that supplementary endpoint.
                              example: 20000
                              format: double
                              maximum: 999999.99
                              minimum: 0.01
                              nullable: true
                              pattern: ^(\d{1,6})(.\d{1,2})?$
                              readOnly: false
                              type: number
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 fiscal company cars for an employment
      tags:
        - Fiscal company car
    post:
      description: |
        __Activity name:__ PostFiscalCompanyCarByEmploymentId
            

        Create a fiscal company cars record for an employment.

        Please note this resource is related for the registration of the company car for tax purposes and will be included in the salary calculations.  This is NOT directly related to the registration of the company car(s) related to the HRM-module Verstrekking

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostFiscalCompanyCarByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                additionalTaxLiabilityGroup:
                  description: |
                    Indication for what additional tax liability percentage (bijtelling) should be used for calculating the tax liabiltiy in the payroll process.

                    It is possible to acquire a value for this field based on the RDW-registration of the vehicle registration number (license plate) by calling that supplementary endpoint.
                  format: metaData
                  nullable: false
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Standaard tarief (25% tot 2017)
                      maxLength: 100
                      minLength: 0
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                dateOfFirstAdmission:
                  description: First day of admission for the vehicle (datum eerste toelating). It is possible to acquire a value for this field based on the RDW-registration by calling that supplementary endpoint.
                  example: 2018-01-01
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                deviatingAdditionalTaxLiability:
                  description: |
                    Normally Loket will calculate the applicable tax liability based on the value and tax liability group of the car. However this field may OVERRIDE any other values, and in that case this amount will be applied as the applicable tax liability amount.
                  example: 20000
                  format: double
                  maximum: 999999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,6})(.\d{1,2})?$
                  readOnly: false
                  type: number
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2023-10-23
                  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
                licensePlateNumber:
                  description: |
                    Vehicle registration number (license plate) of the fiscal company car. The number should be provided with or without any hyphens (-).
                  example: GP586D
                  maxLength: 15
                  minLength: 0
                  nullable: true
                  readOnly: false
                  type: string
                reasonForNoAdditionalTaxLiability:
                  description: |
                    In case the employment does have a fiscal company car but no additional tax liability should be applied, then the reason should be provided for the payroll tax return.
                  format: metaData
                  nullable: true
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: (2) Werknemer heeft beschikking belastingdienst
                      maxLength: 50
                      minLength: 0
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                startDate:
                  description: |-
                    The start date of the entity.

                    A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                  example: 2021-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                taxableBenefitForPrivateUse:
                  description: |
                    Taxable benefit for private use (eigen bijdrage van de werknemer) may be entered here, this will lower the tax liability to be paid in the payrolling process.
                  example: 2000
                  format: double
                  maximum: 999999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,6})(.\d{1,2})?$
                  readOnly: false
                  type: number
                valueForTaxPurposes:
                  description: |
                    The value of the car for tax purposes. This field may only be NULL if a reason for no additional tax liability (reden voor geen bijtelling) is provided.
                    It is possible to acquire a value for this field based on the RDW-registration by calling that supplementary endpoint.
                  example: 20000
                  format: double
                  maximum: 999999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,6})(.\d{1,2})?$
                  readOnly: false
                  type: number
              type: object
        description: Fiscal Company Car record to add to the employment.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          additionalTaxLiabilityGroup:
                            description: |
                              Indication for what additional tax liability percentage (bijtelling) should be used for calculating the tax liabiltiy in the payroll process.

                              It is possible to acquire a value for this field based on the RDW-registration of the vehicle registration number (license plate) by calling that supplementary endpoint.
                            format: metaData
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Standaard tarief (25% tot 2017)
                                maxLength: 100
                                minLength: 0
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          dateOfFirstAdmission:
                            description: First day of admission for the vehicle (datum eerste toelating). It is possible to acquire a value for this field based on the RDW-registration by calling that supplementary endpoint.
                            example: 2018-01-01
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          deviatingAdditionalTaxLiability:
                            description: |
                              Normally Loket will calculate the applicable tax liability based on the value and tax liability group of the car. However this field may OVERRIDE any other values, and in that case this amount will be applied as the applicable tax liability amount.
                            example: 20000
                            format: double
                            maximum: 999999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,6})(.\d{1,2})?$
                            readOnly: false
                            type: number
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2023-10-23
                            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
                          licensePlateNumber:
                            description: |
                              Vehicle registration number (license plate) of the fiscal company car. The number should be provided with or without any hyphens (-).
                            example: GP586D
                            maxLength: 15
                            minLength: 0
                            nullable: true
                            readOnly: false
                            type: string
                          reasonForNoAdditionalTaxLiability:
                            description: |
                              In case the employment does have a fiscal company car but no additional tax liability should be applied, then the reason should be provided for the payroll tax return.
                            format: metaData
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: (2) Werknemer heeft beschikking belastingdienst
                                maxLength: 50
                                minLength: 0
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          startDate:
                            description: |-
                              The start date of the entity.

                              A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2021-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          taxableBenefitForPrivateUse:
                            description: |
                              Taxable benefit for private use (eigen bijdrage van de werknemer) may be entered here, this will lower the tax liability to be paid in the payrolling process.
                            example: 2000
                            format: double
                            maximum: 999999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,6})(.\d{1,2})?$
                            readOnly: false
                            type: number
                          valueForTaxPurposes:
                            description: |
                              The value of the car for tax purposes. This field may only be NULL if a reason for no additional tax liability (reden voor geen bijtelling) is provided.
                              It is possible to acquire a value for this field based on the RDW-registration by calling that supplementary endpoint.
                            example: 20000
                            format: double
                            maximum: 999999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,6})(.\d{1,2})?$
                            readOnly: false
                            type: number
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 fiscal company car record for an employment
      tags:
        - Fiscal company car
  "/providers/employers/employees/employments/{employmentId}/fiscalproperties":
    get:
      description: |
        __Activity name:__ GetFiscalPropertiesByEmploymentId
            

        Get the list of fiscal properties for an employment
      operationId: GetFiscalPropertiesByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: true
                          properties:
                            annualSalary:
                              description: "The fiscal annual salary. NL: Fiscaal jaarloon"
                              example: 60000
                              format: double
                              maximum: 999999999
                              minimum: 0
                              nullable: false
                              pattern: ^(\d{0,9})$
                              readOnly: false
                              type: number
                            applyDayTables:
                              description: "Indicates whether the value of the day table is used for the calculation of payroll tax. NL: DagtabelToepassen"
                              example: false
                              nullable: true
                              readOnly: false
                              type: boolean
                            applyDeviatingPayrollTaxPercentageOn:
                              description: "Indicates on what type of payroll calculation the deviating payroll tax percentage is applicable. NL: AfwijkendPercentageToepassen"
                              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). NL: ArbeidskortingToepassen"
                              example: true
                              nullable: false
                              readOnly: false
                              type: boolean
                            applySalarysplit:
                              description: |
                                Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen.
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                value:
                                  description: Description of the type of document
                                  example: LB obv wereldinkomen (%NL/WI)
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            applyStudentDeduction:
                              description: Apply the "Scholierenregeling". NL; ArbeidskortingToepassen
                              example: false
                              nullable: true
                              readOnly: false
                              type: boolean
                            contributionReductionEducation:
                              description: |
                                Afdr. verm. onderwijs
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                value:
                                  description: Description of the type of education
                                  example: 4. Opleiding hbo
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            deviatingCalculationRulePayrollTax:
                              description: Indicates if, while calculating payroll taxes and social security contributions, certain deviations are applicable. NL; Herleidingsregel
                              format: metadata
                              nullable: false
                              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 the deviating payroll tax percentage which is to be applied. NL: AfwijkendLoonbelastingPercentage"
                              example: 25
                              format: double
                              maximum: 99.99
                              minimum: 0
                              nullable: true
                              pattern: ^(\d{1,2})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            deviatingPayrollTaxTableColour:
                              description: "Indicates if there is a deviating payroll tax table is applicable (green vs white table). If 'Niet afwijkend', then the colour is based on the setting at the payroll administration level, either green or white. NL: AfwijkendeKleurLBtabel"
                              format: metadata
                              nullable: false
                              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
                            deviatingPercentageThirtyPercentFacility:
                              description: Indicates a deviating percentage which should be applied for the 30% facility (30%-regeling)
                              example: 20.2345
                              format: double
                              maximum: 29.999999
                              minimum: 0.000001
                              nullable: true
                              pattern: ^(\d{1,2})(\.\d{1,6})?$
                              readOnly: false
                              type: number
                            deviatingSmallJobsArrangement:
                              description: Kleine banenregeling
                              example: false
                              nullable: true
                              readOnly: false
                              type: boolean
                            deviatingTaxTableCode:
                              description: "Indicates if the tax tabel code should be set to a specific code (code loonbelasting). Normally Loket will determine the tax table based on other properties of the employment, however this field allows the user to override this and set the tax table code to 999. Only in exceptional cases this field should have a value. NL: CodeLoonBelastingtabel"
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: 999 Overige gevallen waarin geen tabel is toegepast
                                  maxLength: 80
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            doesWageIncludeAow:
                              description: "Indicates whether wage include AOW pension (affects payrolling). NL: LoonInclusiefAowUitkering"
                              example: false
                              nullable: false
                              readOnly: false
                              type: boolean
                            doesWageIncludeWajong:
                              description: "Indicates whether wage include Wajong benefits (affects payrolling). NL: LoonInclusiefWajong"
                              example: false
                              nullable: false
                              readOnly: false
                              type: boolean
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              format: date
                              nullable: true
                              readOnly: true
                              type: string
                            hasEmployeeLoan:
                              description: Whether an employee loan (Personeelslening) is applicable may be indicated here. The Personeelslening indirectly affects the income tax calculations.
                              example: false
                              nullable: false
                              readOnly: false
                              type: boolean
                            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
                            percentageForeignIncome:
                              description: "Indicates what percentage of the income of this employment is taxable outside the Netherlands. NL: PercentageBuitenlandsInkomen"
                              example: 50
                              format: double
                              maximum: 99.99
                              minimum: 0.01
                              nullable: true
                              pattern: ^(\d{1,2})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            residentOf:
                              description: |
                                Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen. NL: InwonerVan
                              format: metadata
                              nullable: false
                              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
                            specialIndication:
                              description: Indications This field is no longer used sinds 2005
                              properties:
                                four:
                                  description: Speciale aanduiding 4
                                  example: 1
                                  format: int32
                                  nullable: true
                                  readOnly: true
                                  type: integer
                                one:
                                  description: Speciale aanduiding 1
                                  example: 1
                                  format: int32
                                  nullable: true
                                  readOnly: true
                                  type: integer
                                three:
                                  description: Speciale aanduiding 3
                                  example: 1
                                  format: int32
                                  nullable: true
                                  readOnly: true
                                  type: integer
                                two:
                                  description: Speciale aanduiding 2
                                  example: 1
                                  format: int32
                                  nullable: true
                                  readOnly: true
                                  type: integer
                              readOnly: true
                              type: object
                            startDate:
                              description: |-
                                The start date of the entity.

                                A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                              example: 2018-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            thirtyPercentFacility:
                              description: If the employee comes to work in the Netherlands from another country, the employer may grant an untaxed reimbursement. (30%-regeling).
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Netto
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            usesTransportByWithholdingAgent:
                              description: The so-called 'vervoer vanwege inhoudingsplichtige' is a tax rule that may apply. By example when the employer organizes the transport for the employee.
                              example: false
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 fiscal properties for an employment
      tags:
        - Fiscal properties
    post:
      description: |
        __Activity name:__ PostFiscalPropertiesByEmploymentId
            

        Create a fiscal properties record for an employment

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostFiscalPropertiesByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                annualSalary:
                  description: "The fiscal annual salary. NL: Fiscaal jaarloon"
                  example: 60000
                  format: double
                  maximum: 999999999
                  minimum: 0
                  nullable: false
                  pattern: ^(\d{0,9})$
                  readOnly: false
                  type: number
                applyDayTables:
                  description: "Indicates whether the value of the day table is used for the calculation of payroll tax. NL: DagtabelToepassen"
                  example: false
                  nullable: true
                  readOnly: false
                  type: boolean
                applyDeviatingPayrollTaxPercentageOn:
                  description: "Indicates on what type of payroll calculation the deviating payroll tax percentage is applicable. NL: AfwijkendPercentageToepassen"
                  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). NL: ArbeidskortingToepassen"
                  example: true
                  nullable: false
                  readOnly: false
                  type: boolean
                applySalarysplit:
                  description: |
                    Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen.
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                    value:
                      description: Description of the type of document
                      example: LB obv wereldinkomen (%NL/WI)
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                applyStudentDeduction:
                  description: Apply the "Scholierenregeling". NL; ArbeidskortingToepassen
                  example: false
                  nullable: true
                  readOnly: false
                  type: boolean
                contributionReductionEducation:
                  description: |
                    Afdr. verm. onderwijs
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                    value:
                      description: Description of the type of education
                      example: 4. Opleiding hbo
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                deviatingCalculationRulePayrollTax:
                  description: Indicates if, while calculating payroll taxes and social security contributions, certain deviations are applicable. NL; Herleidingsregel
                  format: metadata
                  nullable: false
                  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 the deviating payroll tax percentage which is to be applied. NL: AfwijkendLoonbelastingPercentage"
                  example: 25
                  format: double
                  maximum: 99.99
                  minimum: 0
                  nullable: true
                  pattern: ^(\d{1,2})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                deviatingPayrollTaxTableColour:
                  description: "Indicates if there is a deviating payroll tax table is applicable (green vs white table). If 'Niet afwijkend', then the colour is based on the setting at the payroll administration level, either green or white. NL: AfwijkendeKleurLBtabel"
                  format: metadata
                  nullable: false
                  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
                deviatingPercentageThirtyPercentFacility:
                  description: Indicates a deviating percentage which should be applied for the 30% facility (30%-regeling)
                  example: 20.2345
                  format: double
                  maximum: 29.999999
                  minimum: 0.000001
                  nullable: true
                  pattern: ^(\d{1,2})(\.\d{1,6})?$
                  readOnly: false
                  type: number
                deviatingSmallJobsArrangement:
                  description: Kleine banenregeling
                  example: false
                  nullable: true
                  readOnly: false
                  type: boolean
                deviatingTaxTableCode:
                  description: "Indicates if the tax tabel code should be set to a specific code (code loonbelasting). Normally Loket will determine the tax table based on other properties of the employment, however this field allows the user to override this and set the tax table code to 999. Only in exceptional cases this field should have a value. NL: CodeLoonBelastingtabel"
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: 999 Overige gevallen waarin geen tabel is toegepast
                      maxLength: 80
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                doesWageIncludeAow:
                  description: "Indicates whether wage include AOW pension (affects payrolling). NL: LoonInclusiefAowUitkering"
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                doesWageIncludeWajong:
                  description: "Indicates whether wage include Wajong benefits (affects payrolling). NL: LoonInclusiefWajong"
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: true
                  type: string
                hasEmployeeLoan:
                  description: Whether an employee loan (Personeelslening) is applicable may be indicated here. The Personeelslening indirectly affects the income tax calculations.
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                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
                percentageForeignIncome:
                  description: "Indicates what percentage of the income of this employment is taxable outside the Netherlands. NL: PercentageBuitenlandsInkomen"
                  example: 50
                  format: double
                  maximum: 99.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,2})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                residentOf:
                  description: |
                    Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen. NL: InwonerVan
                  format: metadata
                  nullable: false
                  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
                specialIndication:
                  description: Indications This field is no longer used sinds 2005
                  properties:
                    four:
                      description: Speciale aanduiding 4
                      example: 1
                      format: int32
                      nullable: true
                      readOnly: true
                      type: integer
                    one:
                      description: Speciale aanduiding 1
                      example: 1
                      format: int32
                      nullable: true
                      readOnly: true
                      type: integer
                    three:
                      description: Speciale aanduiding 3
                      example: 1
                      format: int32
                      nullable: true
                      readOnly: true
                      type: integer
                    two:
                      description: Speciale aanduiding 2
                      example: 1
                      format: int32
                      nullable: true
                      readOnly: true
                      type: integer
                  readOnly: true
                  type: object
                startDate:
                  description: |-
                    The start date of the entity.

                    A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                thirtyPercentFacility:
                  description: If the employee comes to work in the Netherlands from another country, the employer may grant an untaxed reimbursement. (30%-regeling).
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Netto
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                usesTransportByWithholdingAgent:
                  description: The so-called 'vervoer vanwege inhoudingsplichtige' is a tax rule that may apply. By example when the employer organizes the transport for the employee.
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
              type: object
        description: Fiscal properties record to add to the employment.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          annualSalary:
                            description: "The fiscal annual salary. NL: Fiscaal jaarloon"
                            example: 60000
                            format: double
                            maximum: 999999999
                            minimum: 0
                            nullable: false
                            pattern: ^(\d{0,9})$
                            readOnly: false
                            type: number
                          applyDayTables:
                            description: "Indicates whether the value of the day table is used for the calculation of payroll tax. NL: DagtabelToepassen"
                            example: false
                            nullable: true
                            readOnly: false
                            type: boolean
                          applyDeviatingPayrollTaxPercentageOn:
                            description: "Indicates on what type of payroll calculation the deviating payroll tax percentage is applicable. NL: AfwijkendPercentageToepassen"
                            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). NL: ArbeidskortingToepassen"
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          applySalarysplit:
                            description: |
                              Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                              value:
                                description: Description of the type of document
                                example: LB obv wereldinkomen (%NL/WI)
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          applyStudentDeduction:
                            description: Apply the "Scholierenregeling". NL; ArbeidskortingToepassen
                            example: false
                            nullable: true
                            readOnly: false
                            type: boolean
                          contributionReductionEducation:
                            description: |
                              Afdr. verm. onderwijs
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                              value:
                                description: Description of the type of education
                                example: 4. Opleiding hbo
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          deviatingCalculationRulePayrollTax:
                            description: Indicates if, while calculating payroll taxes and social security contributions, certain deviations are applicable. NL; Herleidingsregel
                            format: metadata
                            nullable: false
                            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 the deviating payroll tax percentage which is to be applied. NL: AfwijkendLoonbelastingPercentage"
                            example: 25
                            format: double
                            maximum: 99.99
                            minimum: 0
                            nullable: true
                            pattern: ^(\d{1,2})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          deviatingPayrollTaxTableColour:
                            description: "Indicates if there is a deviating payroll tax table is applicable (green vs white table). If 'Niet afwijkend', then the colour is based on the setting at the payroll administration level, either green or white. NL: AfwijkendeKleurLBtabel"
                            format: metadata
                            nullable: false
                            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
                          deviatingPercentageThirtyPercentFacility:
                            description: Indicates a deviating percentage which should be applied for the 30% facility (30%-regeling)
                            example: 20.2345
                            format: double
                            maximum: 29.999999
                            minimum: 0.000001
                            nullable: true
                            pattern: ^(\d{1,2})(\.\d{1,6})?$
                            readOnly: false
                            type: number
                          deviatingSmallJobsArrangement:
                            description: Kleine banenregeling
                            example: false
                            nullable: true
                            readOnly: false
                            type: boolean
                          deviatingTaxTableCode:
                            description: "Indicates if the tax tabel code should be set to a specific code (code loonbelasting). Normally Loket will determine the tax table based on other properties of the employment, however this field allows the user to override this and set the tax table code to 999. Only in exceptional cases this field should have a value. NL: CodeLoonBelastingtabel"
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: 999 Overige gevallen waarin geen tabel is toegepast
                                maxLength: 80
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          doesWageIncludeAow:
                            description: "Indicates whether wage include AOW pension (affects payrolling). NL: LoonInclusiefAowUitkering"
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          doesWageIncludeWajong:
                            description: "Indicates whether wage include Wajong benefits (affects payrolling). NL: LoonInclusiefWajong"
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          hasEmployeeLoan:
                            description: Whether an employee loan (Personeelslening) is applicable may be indicated here. The Personeelslening indirectly affects the income tax calculations.
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          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
                          percentageForeignIncome:
                            description: "Indicates what percentage of the income of this employment is taxable outside the Netherlands. NL: PercentageBuitenlandsInkomen"
                            example: 50
                            format: double
                            maximum: 99.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,2})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          residentOf:
                            description: |
                              Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen. NL: InwonerVan
                            format: metadata
                            nullable: false
                            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
                          specialIndication:
                            description: Indications This field is no longer used sinds 2005
                            properties:
                              four:
                                description: Speciale aanduiding 4
                                example: 1
                                format: int32
                                nullable: true
                                readOnly: true
                                type: integer
                              one:
                                description: Speciale aanduiding 1
                                example: 1
                                format: int32
                                nullable: true
                                readOnly: true
                                type: integer
                              three:
                                description: Speciale aanduiding 3
                                example: 1
                                format: int32
                                nullable: true
                                readOnly: true
                                type: integer
                              two:
                                description: Speciale aanduiding 2
                                example: 1
                                format: int32
                                nullable: true
                                readOnly: true
                                type: integer
                            readOnly: true
                            type: object
                          startDate:
                            description: |-
                              The start date of the entity.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          thirtyPercentFacility:
                            description: If the employee comes to work in the Netherlands from another country, the employer may grant an untaxed reimbursement. (30%-regeling).
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Netto
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          usesTransportByWithholdingAgent:
                            description: The so-called 'vervoer vanwege inhoudingsplichtige' is a tax rule that may apply. By example when the employer organizes the transport for the employee.
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 fiscal record for an employment
      tags:
        - Fiscal properties
  "/providers/employers/employees/employments/{employmentId}/healthcareinsuranceactconfigurations":
    get:
      description: |
        __Activity name:__ GetHealthcareInsuranceActConfigurationsByEmploymentId
            

        Get the list of Healthcare Insurance Act configuration records for an employment
      operationId: GetHealthcareInsuranceActConfigurationByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: false
                          properties:
                            additionalContributionEmployer:
                              description: If applicable, please enter any additional contribution (extra bijdrage werkgever) for the employer in relation to the Healthcare Insurance Act (Zorgverzekeringswet).
                              example: 320
                              format: double
                              maximum: 9999.99
                              minimum: 0.01
                              nullable: true
                              pattern: ^(\d{1,4})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            additionalPremium:
                              description: Additional premium (aanvullende premie) on top of the nomial premium may be registered here, if applicable.
                              example: 120
                              format: double
                              maximum: 9999.99
                              minimum: 0.01
                              nullable: true
                              pattern: ^(\d{1,4})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              format: date
                              nullable: true
                              readOnly: true
                              type: string
                            healthcareInsuranceActType:
                              description: Indicates what type of Health Care Insurance Act (Zvw) is applicable for this employment
                              format: metadata
                              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
                            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
                            nominalPremium:
                              description: A nominal premium (nominale premie) for the Healthcare Insurance Act may be registered here, if applicable.
                              example: 320
                              format: double
                              maximum: 9999.99
                              minimum: 0.01
                              nullable: true
                              pattern: ^(\d{1,4})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            startDate:
                              description: |-
                                The start date of the entity.

                                A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                              example: 2018-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 Healthcare Insurance Act records for an employment
      tags:
        - Healthcare Insurance Act
    post:
      description: |
        __Activity name:__ PostHealthcareInsuranceActConfigurationByEmploymentId
            

        Create a Healthcare Insurance Act configuration record for an employment

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostHealthcareInsuranceActConfigurationByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: false
              properties:
                additionalContributionEmployer:
                  description: If applicable, please enter any additional contribution (extra bijdrage werkgever) for the employer in relation to the Healthcare Insurance Act (Zorgverzekeringswet).
                  example: 320
                  format: double
                  maximum: 9999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,4})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                additionalPremium:
                  description: Additional premium (aanvullende premie) on top of the nomial premium may be registered here, if applicable.
                  example: 120
                  format: double
                  maximum: 9999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,4})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: true
                  type: string
                healthcareInsuranceActType:
                  description: Indicates what type of Health Care Insurance Act (Zvw) is applicable for this employment
                  format: metadata
                  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
                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
                nominalPremium:
                  description: A nominal premium (nominale premie) for the Healthcare Insurance Act may be registered here, if applicable.
                  example: 320
                  format: double
                  maximum: 9999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,4})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                startDate:
                  description: |-
                    The start date of the entity.

                    A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
              type: object
        description: Healthcare Insurance Act record to add to the employment.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          additionalContributionEmployer:
                            description: If applicable, please enter any additional contribution (extra bijdrage werkgever) for the employer in relation to the Healthcare Insurance Act (Zorgverzekeringswet).
                            example: 320
                            format: double
                            maximum: 9999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,4})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          additionalPremium:
                            description: Additional premium (aanvullende premie) on top of the nomial premium may be registered here, if applicable.
                            example: 120
                            format: double
                            maximum: 9999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,4})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          healthcareInsuranceActType:
                            description: Indicates what type of Health Care Insurance Act (Zvw) is applicable for this employment
                            format: metadata
                            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
                          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
                          nominalPremium:
                            description: A nominal premium (nominale premie) for the Healthcare Insurance Act may be registered here, if applicable.
                            example: 320
                            format: double
                            maximum: 9999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,4})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          startDate:
                            description: |-
                              The start date of the entity.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 Healthcare Insurance Act record for an employment
      tags:
        - Healthcare Insurance Act
  "/providers/employers/employees/employments/{employmentId}/journalallocations":
    get:
      description: |
        __Activity name:__ GetJournalAllocationsByEmploymentId
            

        Get the list of financial journal allocations (journaliseren module) for an employment. 
      operationId: GetJournalAllocationsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            allocationBasedOnActualHours:
                              description: |
                                Provide the allocation details within this object in case allocation based on actual hours (=normuren) is applicable. Functional effect; when PayrollPeriodData (=Variabele Gegevens) are created for this Employment, then the default values for the fields costCenter and costUnit wil be based on the settings within this resource.  So if you are an external party and want to provide costUnit and/or costCenter when sending PayrollPeriodData,  make sure you first acquire the default values by calling the `/ defaults` for the PayrollPeriodData resource (!).

                                Please note that this object MUST be null when `allocationBasedOnFixedWeights` is to be applied. Only one of the two may be provided.
                              nullable: true
                              properties:
                                costCenter:
                                  description: |
                                    The applicable cost center (=kostenplaats).

                                    `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: false
                                  properties:
                                    code:
                                      example: SAL073
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    description:
                                      example: Sales Den Bosch
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                costUnit:
                                  description: |
                                    The applicable cost center (=kostendrager).
                                    `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    code:
                                      example: "01"
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    description:
                                      example: Cars
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                              type: object
                            allocationBasedOnFixedWeights:
                              description: |
                                Provide the allocation details within this object when allocation based on weights (=factor) is applicable. Functional effect; if the costCenter and/or costUnit are provided within this object than the journal run calculations will use these fixed weights when performing calculations. Any costCenters and costUnits in the PayrollPeriodData records will be ignored for the calculations in that case.

                                Please note that this object MUST be null when `allocationBasedOnActualHours` is to be applied. Only one of the two may be provided. 
                              items:
                                properties:
                                  costCenter:
                                    description: |
                                      The applicable cost center (=kostenplaats).

                                      `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                    format: metadata
                                    nullable: false
                                    properties:
                                      code:
                                        example: SAL073
                                        nullable: false
                                        readOnly: true
                                        type: string
                                      description:
                                        example: Sales Den Bosch
                                        nullable: false
                                        readOnly: true
                                        type: string
                                      key:
                                        example: 2
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                    type: object
                                  costUnit:
                                    description: |
                                      The applicable cost center (=kostendrager).
                                      `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                    format: metadata
                                    nullable: true
                                    properties:
                                      code:
                                        example: "01"
                                        nullable: false
                                        readOnly: true
                                        type: string
                                      description:
                                        example: Cars
                                        nullable: false
                                        readOnly: true
                                        type: string
                                      key:
                                        example: 2
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                    type: object
                                  weight:
                                    description: |
                                      The weight (factor) determines the relative weight when allocating the costs for this specific combination of costCenter and costUnit.
                                    example: 1
                                    format: int32
                                    maximum: 9999
                                    minimum: 1
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                type: object
                              nullable: true
                              type: array
                            endPeriod:
                              format: metadata
                              nullable: true
                              properties:
                                periodEndDate:
                                  description: |
                                    The last day of the payroll period.
                                  example: 2018-01-31
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                periodNumber:
                                  description: |
                                    The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                  example: 1
                                  format: int32
                                  maximum: 53
                                  minimum: 1
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                periodStartDate:
                                  description: |
                                    The first day of the payroll period.
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                year:
                                  description: |
                                    The year of the last payroll period for which the journal allocation is applicable.
                                  example: 2017
                                  format: int32
                                  maximum: 9999
                                  minimum: 2000
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              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
                            journalProfileConfiguration:
                              description: Indicates to which journal profiel configuration the record relates
                              format: metadata
                              nullable: false
                              properties:
                                endPeriod:
                                  format: metadata
                                  nullable: true
                                  properties:
                                    periodEndDate:
                                      description: |
                                        The last day of the payroll period.
                                      example: 2017-01-31
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    periodNumber:
                                      description: |
                                        The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                      example: 1
                                      format: int32
                                      maximum: 53
                                      minimum: 1
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    periodStartDate:
                                      description: |
                                        The first day of the payroll period.
                                      example: 2017-01-01
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    year:
                                      description: |
                                        The year of the first payroll period for which the journal allocation is applicable.
                                      example: 2017
                                      format: int32
                                      maximum: 9999
                                      minimum: 2000
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                  readOnly: true
                                  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: false
                                  type: string
                                journalProfile:
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: General ledger supermarkets
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                startPeriod:
                                  format: metadata
                                  nullable: false
                                  properties:
                                    periodEndDate:
                                      description: |
                                        The last day of the payroll period.
                                      example: 2017-01-31
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    periodNumber:
                                      description: |
                                        The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                      example: 1
                                      format: int32
                                      maximum: 53
                                      minimum: 1
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    periodStartDate:
                                      description: |
                                        The first day of the payroll period.
                                      example: 2017-01-01
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    year:
                                      description: |
                                        The year of the first payroll period for which the journal allocation is applicable.
                                      example: 2017
                                      format: int32
                                      maximum: 9999
                                      minimum: 2000
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                  readOnly: true
                                  type: object
                              readOnly: true
                              type: object
                            startPeriod:
                              format: metadata
                              nullable: false
                              properties:
                                periodEndDate:
                                  description: |
                                    The last day of the payroll period.
                                  example: 2018-01-31
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                periodNumber:
                                  description: |
                                    The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                  example: 1
                                  format: int32
                                  maximum: 53
                                  minimum: 1
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                periodStartDate:
                                  description: |
                                    The first day of the payroll period.
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                year:
                                  description: |
                                    The year of the first payroll period for which the journal allocation is applicable.
                                  example: 2017
                                  format: int32
                                  maximum: 9999
                                  minimum: 2000
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 journal allocations for an employment
      tags:
        - Journal allocation
    post:
      description: |
        __Activity name:__ PostJournalAllocationByEmploymentId
            

        Create a new financial journal allocation record for an employment (journaliseren module).

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL. Possible options dependent on a specific `startPeriod` can be acquired via `/metadata/year/{year}/period/{period}

        __Defaults :__ There is NO /defaults endpoint available for this resource.
      operationId: PostJournalAllocationByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                allocationBasedOnActualHours:
                  description: |
                    Provide the allocation details within this object in case allocation based on actual hours (=normuren) is applicable. Functional effect; when PayrollPeriodData (=Variabele Gegevens) are created for this Employment, then the default values for the fields costCenter and costUnit wil be based on the settings within this resource.  So if you are an external party and want to provide costUnit and/or costCenter when sending PayrollPeriodData,  make sure you first acquire the default values by calling the `/ defaults` for the PayrollPeriodData resource (!).

                    Please note that this object MUST be null when `allocationBasedOnFixedWeights` is to be applied. Only one of the two may be provided.
                  nullable: true
                  properties:
                    costCenter:
                      description: |
                        The applicable cost center (=kostenplaats).

                        `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                      format: metadata
                      nullable: false
                      properties:
                        code:
                          example: SAL073
                          nullable: false
                          readOnly: true
                          type: string
                        description:
                          example: Sales Den Bosch
                          nullable: false
                          readOnly: true
                          type: string
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                      type: object
                    costUnit:
                      description: |
                        The applicable cost center (=kostendrager).
                        `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                      format: metadata
                      nullable: true
                      properties:
                        code:
                          example: "01"
                          nullable: false
                          readOnly: true
                          type: string
                        description:
                          example: Cars
                          nullable: false
                          readOnly: true
                          type: string
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                      type: object
                  type: object
                allocationBasedOnFixedWeights:
                  description: |
                    Provide the allocation details within this object when allocation based on weights (=factor) is applicable. Functional effect; if the costCenter and/or costUnit are provided within this object than the journal run calculations will use these fixed weights when performing calculations. Any costCenters and costUnits in the PayrollPeriodData records will be ignored for the calculations in that case.

                    Please note that this object MUST be null when `allocationBasedOnActualHours` is to be applied. Only one of the two may be provided. 
                  items:
                    properties:
                      costCenter:
                        description: |
                          The applicable cost center (=kostenplaats).

                          `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                        format: metadata
                        nullable: false
                        properties:
                          code:
                            example: SAL073
                            nullable: false
                            readOnly: true
                            type: string
                          description:
                            example: Sales Den Bosch
                            nullable: false
                            readOnly: true
                            type: string
                          key:
                            example: 2
                            format: int32
                            nullable: false
                            readOnly: false
                            type: integer
                        type: object
                      costUnit:
                        description: |
                          The applicable cost center (=kostendrager).
                          `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                        format: metadata
                        nullable: true
                        properties:
                          code:
                            example: "01"
                            nullable: false
                            readOnly: true
                            type: string
                          description:
                            example: Cars
                            nullable: false
                            readOnly: true
                            type: string
                          key:
                            example: 2
                            format: int32
                            nullable: false
                            readOnly: false
                            type: integer
                        type: object
                      weight:
                        description: |
                          The weight (factor) determines the relative weight when allocating the costs for this specific combination of costCenter and costUnit.
                        example: 1
                        format: int32
                        maximum: 9999
                        minimum: 1
                        nullable: false
                        readOnly: false
                        type: integer
                    type: object
                  nullable: true
                  type: array
                endPeriod:
                  format: metadata
                  nullable: true
                  properties:
                    periodEndDate:
                      description: |
                        The last day of the payroll period.
                      example: 2018-01-31
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    periodNumber:
                      description: |
                        The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                      example: 1
                      format: int32
                      maximum: 53
                      minimum: 1
                      nullable: false
                      readOnly: false
                      type: integer
                    periodStartDate:
                      description: |
                        The first day of the payroll period.
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    year:
                      description: |
                        The year of the last payroll period for which the journal allocation is applicable.
                      example: 2017
                      format: int32
                      maximum: 9999
                      minimum: 2000
                      nullable: false
                      readOnly: false
                      type: integer
                  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
                journalProfileConfiguration:
                  description: Indicates to which journal profiel configuration the record relates
                  format: metadata
                  nullable: false
                  properties:
                    endPeriod:
                      format: metadata
                      nullable: true
                      properties:
                        periodEndDate:
                          description: |
                            The last day of the payroll period.
                          example: 2017-01-31
                          format: date
                          nullable: false
                          readOnly: true
                          type: string
                        periodNumber:
                          description: |
                            The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                          example: 1
                          format: int32
                          maximum: 53
                          minimum: 1
                          nullable: false
                          readOnly: true
                          type: integer
                        periodStartDate:
                          description: |
                            The first day of the payroll period.
                          example: 2017-01-01
                          format: date
                          nullable: false
                          readOnly: true
                          type: string
                        year:
                          description: |
                            The year of the first payroll period for which the journal allocation is applicable.
                          example: 2017
                          format: int32
                          maximum: 9999
                          minimum: 2000
                          nullable: false
                          readOnly: true
                          type: integer
                      readOnly: true
                      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: false
                      type: string
                    journalProfile:
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: General ledger supermarkets
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    startPeriod:
                      format: metadata
                      nullable: false
                      properties:
                        periodEndDate:
                          description: |
                            The last day of the payroll period.
                          example: 2017-01-31
                          format: date
                          nullable: false
                          readOnly: true
                          type: string
                        periodNumber:
                          description: |
                            The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                          example: 1
                          format: int32
                          maximum: 53
                          minimum: 1
                          nullable: false
                          readOnly: true
                          type: integer
                        periodStartDate:
                          description: |
                            The first day of the payroll period.
                          example: 2017-01-01
                          format: date
                          nullable: false
                          readOnly: true
                          type: string
                        year:
                          description: |
                            The year of the first payroll period for which the journal allocation is applicable.
                          example: 2017
                          format: int32
                          maximum: 9999
                          minimum: 2000
                          nullable: false
                          readOnly: true
                          type: integer
                      readOnly: true
                      type: object
                  readOnly: true
                  type: object
                startPeriod:
                  format: metadata
                  nullable: false
                  properties:
                    periodEndDate:
                      description: |
                        The last day of the payroll period.
                      example: 2018-01-31
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    periodNumber:
                      description: |
                        The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                      example: 1
                      format: int32
                      maximum: 53
                      minimum: 1
                      nullable: false
                      readOnly: false
                      type: integer
                    periodStartDate:
                      description: |
                        The first day of the payroll period.
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    year:
                      description: |
                        The year of the first payroll period for which the journal allocation is applicable.
                      example: 2017
                      format: int32
                      maximum: 9999
                      minimum: 2000
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
        description: Journal allocation to add to the employment.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          allocationBasedOnActualHours:
                            description: |
                              Provide the allocation details within this object in case allocation based on actual hours (=normuren) is applicable. Functional effect; when PayrollPeriodData (=Variabele Gegevens) are created for this Employment, then the default values for the fields costCenter and costUnit wil be based on the settings within this resource.  So if you are an external party and want to provide costUnit and/or costCenter when sending PayrollPeriodData,  make sure you first acquire the default values by calling the `/ defaults` for the PayrollPeriodData resource (!).

                              Please note that this object MUST be null when `allocationBasedOnFixedWeights` is to be applied. Only one of the two may be provided.
                            nullable: true
                            properties:
                              costCenter:
                                description: |
                                  The applicable cost center (=kostenplaats).

                                  `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                format: metadata
                                nullable: false
                                properties:
                                  code:
                                    example: SAL073
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  description:
                                    example: Sales Den Bosch
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                type: object
                              costUnit:
                                description: |
                                  The applicable cost center (=kostendrager).
                                  `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                format: metadata
                                nullable: true
                                properties:
                                  code:
                                    example: "01"
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  description:
                                    example: Cars
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                type: object
                            type: object
                          allocationBasedOnFixedWeights:
                            description: |
                              Provide the allocation details within this object when allocation based on weights (=factor) is applicable. Functional effect; if the costCenter and/or costUnit are provided within this object than the journal run calculations will use these fixed weights when performing calculations. Any costCenters and costUnits in the PayrollPeriodData records will be ignored for the calculations in that case.

                              Please note that this object MUST be null when `allocationBasedOnActualHours` is to be applied. Only one of the two may be provided. 
                            items:
                              properties:
                                costCenter:
                                  description: |
                                    The applicable cost center (=kostenplaats).

                                    `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: false
                                  properties:
                                    code:
                                      example: SAL073
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    description:
                                      example: Sales Den Bosch
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                costUnit:
                                  description: |
                                    The applicable cost center (=kostendrager).
                                    `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    code:
                                      example: "01"
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    description:
                                      example: Cars
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                weight:
                                  description: |
                                    The weight (factor) determines the relative weight when allocating the costs for this specific combination of costCenter and costUnit.
                                  example: 1
                                  format: int32
                                  maximum: 9999
                                  minimum: 1
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            nullable: true
                            type: array
                          endPeriod:
                            format: metadata
                            nullable: true
                            properties:
                              periodEndDate:
                                description: |
                                  The last day of the payroll period.
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: |
                                  The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                example: 1
                                format: int32
                                maximum: 53
                                minimum: 1
                                nullable: false
                                readOnly: false
                                type: integer
                              periodStartDate:
                                description: |
                                  The first day of the payroll period.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: |
                                  The year of the last payroll period for which the journal allocation is applicable.
                                example: 2017
                                format: int32
                                maximum: 9999
                                minimum: 2000
                                nullable: false
                                readOnly: false
                                type: integer
                            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
                          journalProfileConfiguration:
                            description: Indicates to which journal profiel configuration the record relates
                            format: metadata
                            nullable: false
                            properties:
                              endPeriod:
                                format: metadata
                                nullable: true
                                properties:
                                  periodEndDate:
                                    description: |
                                      The last day of the payroll period.
                                    example: 2017-01-31
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  periodNumber:
                                    description: |
                                      The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                    example: 1
                                    format: int32
                                    maximum: 53
                                    minimum: 1
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  periodStartDate:
                                    description: |
                                      The first day of the payroll period.
                                    example: 2017-01-01
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  year:
                                    description: |
                                      The year of the first payroll period for which the journal allocation is applicable.
                                    example: 2017
                                    format: int32
                                    maximum: 9999
                                    minimum: 2000
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                readOnly: true
                                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: false
                                type: string
                              journalProfile:
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: General ledger supermarkets
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              startPeriod:
                                format: metadata
                                nullable: false
                                properties:
                                  periodEndDate:
                                    description: |
                                      The last day of the payroll period.
                                    example: 2017-01-31
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  periodNumber:
                                    description: |
                                      The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                    example: 1
                                    format: int32
                                    maximum: 53
                                    minimum: 1
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  periodStartDate:
                                    description: |
                                      The first day of the payroll period.
                                    example: 2017-01-01
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  year:
                                    description: |
                                      The year of the first payroll period for which the journal allocation is applicable.
                                    example: 2017
                                    format: int32
                                    maximum: 9999
                                    minimum: 2000
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                readOnly: true
                                type: object
                            readOnly: true
                            type: object
                          startPeriod:
                            format: metadata
                            nullable: false
                            properties:
                              periodEndDate:
                                description: |
                                  The last day of the payroll period.
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: |
                                  The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the last payroll period for which the journal allocation is applicable.
                                example: 1
                                format: int32
                                maximum: 53
                                minimum: 1
                                nullable: false
                                readOnly: false
                                type: integer
                              periodStartDate:
                                description: |
                                  The first day of the payroll period.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: |
                                  The year of the first payroll period for which the journal allocation is applicable.
                                example: 2017
                                format: int32
                                maximum: 9999
                                minimum: 2000
                                nullable: false
                                readOnly: false
                                type: integer
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 new journal allocation record for an employment
      tags:
        - Journal allocation
  "/providers/employers/employees/employments/{employmentId}/leave":
    get:
      description: |
        __Activity name :__ GetLeaveByEmploymentId <br/>  <br/>  Returns all the leave entries (both addition and subtraction) for the given employment.
      operationId: GetLeaveByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            comment:
                              example: some comment
                              maxLength: 4000
                              nullable: true
                              readOnly: false
                              type: string
                            endDate:
                              description: The end date of the leave requested (last day of the leave)
                              example: 2017-11-01
                              format: date
                              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
                            isAccrual:
                              description: |
                                Indicates whether the request is for accrual of leave.
                                - false will result in a reduction of the employee's leave entitlement
                                - true will result in an increase of the employee's leave entitlement
                              example: false
                              nullable: false
                              readOnly: false
                              type: boolean
                            leaveType:
                              description: |-
                                The type of leave requested by the employee
                                `leaveType` is a metadata field within the employer context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                balanceExceedsYear:
                                  description: |
                                    Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                                  example: true
                                  nullable: false
                                  readOnly: true
                                  type: boolean
                                key:
                                  description: |
                                    The key for the leave type.
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    The description for the leave type. Note that leave types can be overridden at the employer level. In these cases the description at the employer level takes precedence over the default description of the leave type.
                                  example: Verlof (bovenwettelijk)
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            numberOfUnits:
                              description: The number of leave units requested
                              example: 8
                              format: double
                              maximum: 999.99
                              minimum: 0
                              nullable: false
                              pattern: ^(\d{1,3})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            origin:
                              nullable: false
                              properties:
                                leavePolicy:
                                  description: |-
                                    The leave policy for which the record was created. Will only have a value if `meansOfCreation` indicates a leave policy

                                    `leavePolicy` is a metadata field within the employer context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    id:
                                      description: The unique identifier (a 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
                                    leaveUnitType:
                                      description: The type of leave units either days or hours
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          description: |
                                            The key for the leave unit Type.
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        value:
                                          description: |
                                            The description for the leave unit type
                                          example: Uren
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      type: object
                                    value:
                                      description: |
                                        The description of the leave regulation.
                                      example: Default leave Regulations
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                meansOfCreation:
                                  description: The means of creation  of the record
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      description: |
                                        The key for the means of creation
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    value:
                                      description: |
                                        The description for the leave unit type
                                      example: individual
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                              readOnly: true
                              type: object
                            relatedLeave:
                              description: |-
                                Incase two leave records are linked to a single leave request the ID of the linked leave record is returned in this field. This is done because when deleting a leave record linked to a leave request the other leave record linked to that leave request is also deleted

                                The only functional scenario when this may occur is when a leave request is entered for leaveType 16 (Verlof). Depending on the leave balances, this might result in both a leave booking for Verlof (wettelijk) and Verlof (botenwettelijk).
                              nullable: true
                              properties:
                                id:
                                  description: The unique identifier (a 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
                              readOnly: true
                              type: object
                            relatedLeaveRequest:
                              description: Incase that the leave record is the result of the approval of a leave request this value will be set to the ID of that leave request.
                              nullable: true
                              properties:
                                id:
                                  description: The unique identifier (a 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
                              readOnly: true
                              type: object
                            startDate:
                              description: The start date of the leave requested
                              example: 2017-11-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            unitType:
                              description: If known indicates what the unit type (hours or days) is for `numberOfUnits`. Otherwise the field will be null.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  description: |
                                    The key for the unit type
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    The description for the unit type
                                  example: Uren
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 all the leave entries
      tags:
        - Leave
    post:
      description: |
        __Activity name :__ PostLeaveByEmploymentId

        Add a Leave record for an employment
      operationId: PostLeaveByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                comment:
                  example: some comment
                  maxLength: 4000
                  nullable: true
                  readOnly: false
                  type: string
                endDate:
                  description: The end date of the leave requested (last day of the leave)
                  example: 2017-11-01
                  format: date
                  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
                isAccrual:
                  description: |
                    Indicates whether the request is for accrual of leave.
                    - false will result in a reduction of the employee's leave entitlement
                    - true will result in an increase of the employee's leave entitlement
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                leaveType:
                  description: |-
                    The type of leave requested by the employee
                    `leaveType` is a metadata field within the employer context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    balanceExceedsYear:
                      description: |
                        Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                      example: true
                      nullable: false
                      readOnly: true
                      type: boolean
                    key:
                      description: |
                        The key for the leave type.
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        The description for the leave type. Note that leave types can be overridden at the employer level. In these cases the description at the employer level takes precedence over the default description of the leave type.
                      example: Verlof (bovenwettelijk)
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                numberOfUnits:
                  description: The number of leave units requested
                  example: 8
                  format: double
                  maximum: 999.99
                  minimum: 0
                  nullable: false
                  pattern: ^(\d{1,3})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                origin:
                  nullable: false
                  properties:
                    leavePolicy:
                      description: |-
                        The leave policy for which the record was created. Will only have a value if `meansOfCreation` indicates a leave policy

                        `leavePolicy` is a metadata field within the employer context. Possible values can be managed by the user.
                      format: metadata
                      nullable: true
                      properties:
                        id:
                          description: The unique identifier (a 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
                        leaveUnitType:
                          description: The type of leave units either days or hours
                          format: metadata
                          nullable: false
                          properties:
                            key:
                              description: |
                                The key for the leave unit Type.
                              example: 1
                              format: int32
                              nullable: false
                              readOnly: true
                              type: integer
                            value:
                              description: |
                                The description for the leave unit type
                              example: Uren
                              nullable: false
                              readOnly: true
                              type: string
                          type: object
                        value:
                          description: |
                            The description of the leave regulation.
                          example: Default leave Regulations
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    meansOfCreation:
                      description: The means of creation  of the record
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          description: |
                            The key for the means of creation
                          example: 1
                          format: int32
                          nullable: false
                          readOnly: true
                          type: integer
                        value:
                          description: |
                            The description for the leave unit type
                          example: individual
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                  readOnly: true
                  type: object
                relatedLeave:
                  description: |-
                    Incase two leave records are linked to a single leave request the ID of the linked leave record is returned in this field. This is done because when deleting a leave record linked to a leave request the other leave record linked to that leave request is also deleted

                    The only functional scenario when this may occur is when a leave request is entered for leaveType 16 (Verlof). Depending on the leave balances, this might result in both a leave booking for Verlof (wettelijk) and Verlof (botenwettelijk).
                  nullable: true
                  properties:
                    id:
                      description: The unique identifier (a 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
                  readOnly: true
                  type: object
                relatedLeaveRequest:
                  description: Incase that the leave record is the result of the approval of a leave request this value will be set to the ID of that leave request.
                  nullable: true
                  properties:
                    id:
                      description: The unique identifier (a 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
                  readOnly: true
                  type: object
                startDate:
                  description: The start date of the leave requested
                  example: 2017-11-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                unitType:
                  description: If known indicates what the unit type (hours or days) is for `numberOfUnits`. Otherwise the field will be null.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      description: |
                        The key for the unit type
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        The description for the unit type
                      example: Uren
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          comment:
                            example: some comment
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          endDate:
                            description: The end date of the leave requested (last day of the leave)
                            example: 2017-11-01
                            format: date
                            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
                          isAccrual:
                            description: |
                              Indicates whether the request is for accrual of leave.
                              - false will result in a reduction of the employee's leave entitlement
                              - true will result in an increase of the employee's leave entitlement
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          leaveType:
                            description: |-
                              The type of leave requested by the employee
                              `leaveType` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              balanceExceedsYear:
                                description: |
                                  Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                                example: true
                                nullable: false
                                readOnly: true
                                type: boolean
                              key:
                                description: |
                                  The key for the leave type.
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the leave type. Note that leave types can be overridden at the employer level. In these cases the description at the employer level takes precedence over the default description of the leave type.
                                example: Verlof (bovenwettelijk)
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          numberOfUnits:
                            description: The number of leave units requested
                            example: 8
                            format: double
                            maximum: 999.99
                            minimum: 0
                            nullable: false
                            pattern: ^(\d{1,3})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          origin:
                            nullable: false
                            properties:
                              leavePolicy:
                                description: |-
                                  The leave policy for which the record was created. Will only have a value if `meansOfCreation` indicates a leave policy

                                  `leavePolicy` is a metadata field within the employer context. Possible values can be managed by the user.
                                format: metadata
                                nullable: true
                                properties:
                                  id:
                                    description: The unique identifier (a 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
                                  leaveUnitType:
                                    description: The type of leave units either days or hours
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        description: |
                                          The key for the leave unit Type.
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: true
                                        type: integer
                                      value:
                                        description: |
                                          The description for the leave unit type
                                        example: Uren
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                  value:
                                    description: |
                                      The description of the leave regulation.
                                    example: Default leave Regulations
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              meansOfCreation:
                                description: The means of creation  of the record
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The key for the means of creation
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  value:
                                    description: |
                                      The description for the leave unit type
                                    example: individual
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                            readOnly: true
                            type: object
                          relatedLeave:
                            description: |-
                              Incase two leave records are linked to a single leave request the ID of the linked leave record is returned in this field. This is done because when deleting a leave record linked to a leave request the other leave record linked to that leave request is also deleted

                              The only functional scenario when this may occur is when a leave request is entered for leaveType 16 (Verlof). Depending on the leave balances, this might result in both a leave booking for Verlof (wettelijk) and Verlof (botenwettelijk).
                            nullable: true
                            properties:
                              id:
                                description: The unique identifier (a 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
                            readOnly: true
                            type: object
                          relatedLeaveRequest:
                            description: Incase that the leave record is the result of the approval of a leave request this value will be set to the ID of that leave request.
                            nullable: true
                            properties:
                              id:
                                description: The unique identifier (a 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
                            readOnly: true
                            type: object
                          startDate:
                            description: The start date of the leave requested
                            example: 2017-11-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          unitType:
                            description: If known indicates what the unit type (hours or days) is for `numberOfUnits`. Otherwise the field will be null.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                description: |
                                  The key for the unit type
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the unit type
                                example: Uren
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 leave record for an employment
      tags:
        - Leave
  "/providers/employers/employees/employments/{employmentId}/leave/defaults":
    get:
      description: |
        __Activity name :__ GetLeaveDefaultsByEmploymentId

        Returns the default values for all the fields. In case no default is present `null` will be returned.
      operationId: GetLeaveDefaultsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
              examples:
                defaults:
                  value:
                    content:
                      comment: null
                      endDate: <today>
                      id: null
                      isAccrual: false
                      leaveType:
                        balanceExceedsYear: true
                        key: 1
                        value: Verlof (bovenwettelijk)
                      numberOfUnits: 8
                      origin: null
                      relatedLeave: null
                      relatedLeaveRequest: null
                      startDate: <today>
                    messages: []
                    version:
                      obsoleteDate: null
                      resourceVersion: 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: 2018-12-31
                            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 <field>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: BrokenBusinessRule
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            comment:
                              example: some comment
                              maxLength: 4000
                              nullable: true
                              readOnly: false
                              type: string
                            endDate:
                              description: The end date of the leave requested (last day of the leave)
                              example: 2017-11-01
                              format: date
                              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
                            isAccrual:
                              description: |
                                Indicates whether the request is for accrual of leave.
                                - false will result in a reduction of the employee's leave entitlement
                                - true will result in an increase of the employee's leave entitlement
                              example: false
                              nullable: false
                              readOnly: false
                              type: boolean
                            leaveType:
                              description: |-
                                The type of leave requested by the employee
                                `leaveType` is a metadata field within the employer context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                balanceExceedsYear:
                                  description: |
                                    Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                                  example: true
                                  nullable: false
                                  readOnly: true
                                  type: boolean
                                key:
                                  description: |
                                    The key for the leave type.
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    The description for the leave type. Note that leave types can be overridden at the employer level. In these cases the description at the employer level takes precedence over the default description of the leave type.
                                  example: Verlof (bovenwettelijk)
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            numberOfUnits:
                              description: The number of leave units requested
                              example: 8
                              format: double
                              maximum: 999.99
                              minimum: 0
                              nullable: false
                              pattern: ^(\d{1,3})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            origin:
                              nullable: false
                              properties:
                                leavePolicy:
                                  description: |-
                                    The leave policy for which the record was created. Will only have a value if `meansOfCreation` indicates a leave policy

                                    `leavePolicy` is a metadata field within the employer context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    id:
                                      description: The unique identifier (a 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
                                    leaveUnitType:
                                      description: The type of leave units either days or hours
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          description: |
                                            The key for the leave unit Type.
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        value:
                                          description: |
                                            The description for the leave unit type
                                          example: Uren
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      type: object
                                    value:
                                      description: |
                                        The description of the leave regulation.
                                      example: Default leave Regulations
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                meansOfCreation:
                                  description: The means of creation  of the record
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      description: |
                                        The key for the means of creation
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    value:
                                      description: |
                                        The description for the leave unit type
                                      example: individual
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                              readOnly: true
                              type: object
                            relatedLeave:
                              description: |-
                                Incase two leave records are linked to a single leave request the ID of the linked leave record is returned in this field. This is done because when deleting a leave record linked to a leave request the other leave record linked to that leave request is also deleted

                                The only functional scenario when this may occur is when a leave request is entered for leaveType 16 (Verlof). Depending on the leave balances, this might result in both a leave booking for Verlof (wettelijk) and Verlof (botenwettelijk).
                              nullable: true
                              properties:
                                id:
                                  description: The unique identifier (a 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
                              readOnly: true
                              type: object
                            relatedLeaveRequest:
                              description: Incase that the leave record is the result of the approval of a leave request this value will be set to the ID of that leave request.
                              nullable: true
                              properties:
                                id:
                                  description: The unique identifier (a 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
                              readOnly: true
                              type: object
                            startDate:
                              description: The start date of the leave requested
                              example: 2017-11-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            unitType:
                              description: If known indicates what the unit type (hours or days) is for `numberOfUnits`. Otherwise the field will be null.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  description: |
                                    The key for the unit type
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    The description for the unit type
                                  example: Uren
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the default values to be used when POSTing a new record
      tags:
        - Leave
  "/providers/employers/employees/employments/{employmentId}/leave/metadata":
    get:
      description: |
        __Activity name :__ GetLeaveMetadataByEmploymentId

        Returns the metadata values for all the metadata fields.
      operationId: GetLeaveMetadataByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
              examples:
                metadata:
                  value:
                    _embedded:
                      - field: leaveType
                        options:
                          - key: 1
                            value: Verlof wettelijk
                          - key: 15
                            value: Bijzonder verlof
                    currentPage: 1
                    messages: []
                    pageSize: 250
                    totalPages: 1
                    totalSize: 3
                    version:
                      obsoleteDate: null
                      resourceVersion: 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: 2018-12-31
                            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 <field>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: BrokenBusinessRule
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            field:
                              description: |
                                The field name of the metadata field
                              example: <name of the metadata field>
                              nullable: false
                              readOnly: true
                              type: string
                            options:
                              items:
                                properties:
                                  key:
                                    description: |
                                      The key for the metadata field.
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: |
                                      The description for the metadata field
                                    example: <Description>
                                    nullable: false
                                    readOnly: true
                                    type: string
                              nullable: false
                              readOnly: true
                              type: array
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the values for the metadata fields
      tags:
        - Leave
  "/providers/employers/employees/employments/{employmentId}/leave/overview/{year}":
    get:
      description: |
        __Activity name :__ GetLeaveOverviewByEmploymentIdandYear
        Download the leave overview for a year in a single PDF

        __Metadata :__ Possible options for `year` can be acquired (GET) the following URL /providers/employers/employees/employments/{employmentId}/leave/overview/metadata.
      operationId: GetLeaveOverviewByEmploymentIdandYear
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 employment
          in: path
          name: employmentId
          required: true
          schema:
            format: uuid
            type: string
        - description: The payroll year
          in: path
          name: year
          required: true
          schema:
            example: 2018
            format: int32
            maxLength: 4
            type: integer
      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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download the leave overview for an employment and year
      tags:
        - Leave
  "/providers/employers/employees/employments/{employmentId}/leave/proposedleavehours":
    get:
      description: |
        __Activity name :__ GetProposedLeaveHoursByEmploymentId

        Returns the numberOfHours (only in hours) calculated based on the employments working- hours/schedual 

        __Note:__  The function will only work if the employment is either linked to no leave policy or linked to only leave policy(s) that use hours as the unit of leave.

        Further more how the leave hours are calculated can be managed in the leave policy with the `applyLeaveSchedule` and `working hours` resource with the field `calculateUsingWorkPattern.leaveHours` The order is as follows. If calculateUsingWorkPattern.leaveHours is true the work patern from workinghours is used otherwise if applyLeaveSchedule is set to true the `leavePattern` is used otherwise the workinghours are used
      operationId: GetProposedLeaveHoursByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          required: true
          schema:
            format: uuid
            type: string
        - description: The start date of the leave period
          in: query
          name: startDate
          schema:
            example: 2022-08-01
            pattern: date
            type: string
        - description: The end date of the leave period
          in: query
          name: endDate
          schema:
            example: 2022-08-07
            pattern: date
            type: string
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          additionalInformation:
                            description: Provides additional information on the calculation.
                            example: Additional information on the calculation.
                            nullable: true
                            readOnly: true
                            type: string
                          employmentId:
                            description: The unique identifier (a 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
                          methodOfCalculation:
                            description: Indicates which method was used to calculate the proposed leave hours.
                            example: Ploeguren
                            nullable: false
                            readOnly: true
                            type: string
                          proposedLeaveHours:
                            description: The proposed number of leave hours
                            example: 8
                            format: double
                            nullable: false
                            readOnly: true
                            type: number
                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the proposed number of leave hours for an employment
      tags:
        - Leave
  "/providers/employers/employees/employments/{employmentId}/leavebalances":
    get:
      description: |
        __Activity name :__ GetLeaveBalancesByEmploymentId <br/>  <br/>  Returns the yearly leave balances for each leave type.
      operationId: GetLeaveBalancesByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            accrual:
                              description: |
                                The amount of leave units accrued for the leave type in the year
                              example: 30
                              format: double
                              nullable: false
                              pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                              readOnly: true
                              type: number
                            balance:
                              description: |
                                The remaining leave balance for the year and leave type. The balance takes into account the leave usage in the future.
                              example: 40
                              format: double
                              nullable: false
                              pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                              readOnly: true
                              type: number
                            balancePreviousYear:
                              description: |
                                The remaining leave balance from the previous year for the leave type
                              example: 20
                              format: double
                              nullable: false
                              pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                              readOnly: true
                              type: number
                            expires:
                              description: |
                                <ul>
                                  <li>This field is only relevant for the following leave types:</li>
                                  <li><strong>Wettelijk verlof:</strong> Accrued statutory leave from previous years that expires on July 1 of the selected year.</li>
                                  <li><strong>Bovenwettelijk verlof:</strong> Accrued extra-legal leave from 5 years ago and earlier, which expires on Jan 1 of the selected year + 1.</li>
                                  <li><strong>Verlof:</strong> The sum of the two leave types above.</li>
                                </ul>
                              example: 15
                              format: double
                              nullable: false
                              pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                              readOnly: true
                              type: number
                            leaveType:
                              description: |-
                                The type of leave requested by the employee
                                `leaveType` is a metadata field within the employer context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                balanceExceedsYear:
                                  description: |
                                    Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                                  example: true
                                  nullable: false
                                  readOnly: true
                                  type: boolean
                                key:
                                  description: |
                                    The key for the leave type.
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  description: |
                                    The description for the leave type. Note that leave types can be overridden at the employer level. In these cases the description at the employer level takes precedence over the default description of the leave type.
                                  example: Verlof (bovenwettelijk)
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            unitType:
                              description: If known indicates what the unit type (hours or days) is for `balance`, `usageAfterToday`, `usageThroughToday` , `usageTotal` , `accrual` and `balancePreviousYear` . Otherwise the field will be null.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  description: |
                                    The key for the unit type
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    The description for the unit type
                                  example: Uren
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            usageAfterToday:
                              description: |
                                The amount of leave units used for the leave type in the year after today
                              example: 2
                              format: double
                              minimum: 0
                              nullable: false
                              pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                              readOnly: true
                              type: number
                            usageThroughToday:
                              description: |
                                The amount of leave units used for the leave type starting from the beginning of the year up to and including today
                              example: 8
                              format: double
                              nullable: false
                              pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                              readOnly: true
                              type: number
                            usageTotal:
                              description: |
                                The total amount of leave units used for the leave type in the year.
                              example: 10
                              format: double
                              nullable: false
                              pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                              readOnly: true
                              type: number
                            year:
                              description: |
                                The year to which the balance of the leave type applies.
                              example: 2019
                              format: int32
                              maximum: 9999
                              minimum: 2000
                              nullable: false
                              readOnly: true
                              type: integer
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 yearly leave balances for each leave type.
      tags:
        - Leave balance
  "/providers/employers/employees/employments/{employmentId}/leavepolicies":
    get:
      description: |
        __Activity name:__ GetLeavePoliciesByEmploymentId
            

        Get the list of leave policies linked to the employment.
        If a leave policy and employment are linked, that means the employment will be provided the leave based on the policy.
      operationId: GetLeavePoliciesByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: false
                          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: false
                              type: string
                            leaveUnitType:
                              description: If known indicates what the unit type (hours or days) is for `numberOfUnits`. Otherwise the field will be null.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  description: |
                                    The key for the unit type
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  description: |
                                    The description for the unit type
                                  example: Uren
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            value:
                              description: |
                                The description of the leave regulation.
                              example: Default leave Regulation
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 list of linked leave policies for the employment
      tags:
        - Leave policy and employment links
    patch:
      description: |
        __Activity name:__ PatchLeavePoliciesByEmploymentId

        __Metadata :__ Possible options can be acquired (GET) by adding `/metadata` to the POST URL.

        This endpoint enables the user to link or unlink multiple 'linkages' with one call.
      operationId: PatchLeavePoliciesByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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.
                    enum:
                      - link
                      - unlink
                    nullable: false
                    readOnly: false
                    type: string
                  id:
                    description: The unique identifier (GUID/UUID) of the leave policy
                    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: array
        description: The request body contains an array of objects containing a `leavePolicy` and an `action` field.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Link or unlink leave policies for the employment
      tags:
        - Leave policy and employment links
  "/providers/employers/employees/employments/{employmentId}/leaverequests":
    get:
      description: |
        __Activity name :__ GetLeaveRequestsByEmploymentId

        Get a list of all leave requests for the given employment
      operationId: GetLeaveRequestsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            commentEmployee:
                              description: The comment left by the employee
                              example: Vakantie naar Spanje
                              maxLength: 4000
                              nullable: true
                              readOnly: true
                              type: string
                            commentHandler:
                              description: The comment left by the person handling the leave request
                              example: Fijne vakantie!
                              maxLength: 4000
                              nullable: true
                              readOnly: false
                              type: string
                            currentlyAvailableUnits:
                              description: |-
                                The number of leave units (of the leaveType for this leave request) available to the employment.
                                This value can be negative.
                              example: 140
                              format: double
                              nullable: false
                              readOnly: true
                              type: number
                            endDate:
                              description: The end date of the leave requested (last day of the leave)
                              example: 2017-11-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            handledBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. <lastname>", "<initials>" "<prefix>
                                  example: Jong, I
                                  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 user
                                  example: ABC
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            handledTime:
                              description: The date and time the leave request was handled
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              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
                            isAccrual:
                              default: false
                              description: |
                                Indicates whether the request is for accrual of leave.
                                - false will result in a reduction of the employee's leave entitlement
                                - true will result in an increase of the employee's leave entitlement
                              example: false
                              nullable: false
                              readOnly: false
                              type: boolean
                            leaveRequestStatus:
                              description: |-
                                The current status of the leave request

                                The leave request status is changed by using the PATCH endpoint (not the PUT).

                                The following transitions are possible
                                * leaveRequestStatus = submitted -> accepted or rejected
                                * leaveRequestStatus = accepted -> no changes possible
                                * leaveRequestStatus = rejected -> submitted
                                * leaveRequestStatus = revoked by user -> no changes possible
                                * leaveRequestStatus = related leave deleted -> no changes possible
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 9
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Geaccepteerd
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            leaveType:
                              description: |-
                                The type of leave requested by the employee

                                `leaveType` is a metadata field within the employer context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Verlof (bovenwettelijk)
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            numberOfUnits:
                              description: The number of leave units requested
                              example: 8
                              format: double
                              maximum: 999.99
                              minimum: 0.01
                              nullable: false
                              pattern: ^(\d{1,3})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            startDate:
                              description: The start date of the leave requested
                              example: 2017-11-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            submittedBy:
                              format: metadata
                              nullable: false
                              properties:
                                dateOfBirth:
                                  description: |
                                    The date of birth
                                  example: 1995-05-21
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                employeeNumber:
                                  description: The employee number to uniquely identify a employee within a 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
                                lastNamePartner:
                                  description: The last name of the partner of the employee
                                  example: Wiel
                                  maxLength: 25
                                  nullable: true
                                  readOnly: true
                                  type: string
                                photo:
                                  description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                  example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                  format: url
                                  nullable: true
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the employee
                                  example: van
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                                prefixPartner:
                                  description: The prefix of the partner of the employee
                                  example: van de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            submittedOn:
                              description: The time the leave request was submitted
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            unitType:
                              description: If known indicates what the unit type (hours or days) is for `numberOfUnits`. Otherwise the field will be null.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  description: |
                                    The key for the unit type
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    The description for the unit type
                                  example: Uren
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: leave requests by employment
      tags:
        - Leave request
  "/providers/employers/employees/employments/{employmentId}/notes":
    get:
      description: |
        __Activity name :__ GetEmploymentNotesByEmploymentId

        Get a list of notes, available for the user, for the employment. 
      operationId: GetEmploymentNotesByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            accessibleBy:
                              description: |
                                Indicates who can view this node.
                              nullable: false
                              properties:
                                key:
                                  description: The key for accessible by
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: Description of the accessible by
                                  example: Everyone
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            createdBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            createdOn:
                              description: |
                                The date on which the note was created
                              example: 2018-01-01
                              format: date-time
                              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
                            lastModifiedBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            lastModifiedOn:
                              description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                              example: 2018-01-01
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            note:
                              description: |-
                                The note it self.

                                __Note:__ This is a free text field so users can add htlm/script etc.
                              example: Remember to do xyz
                              maxLength: 4000
                              nullable: true
                              readOnly: false
                              type: string
                            subject:
                              description: subject of the note
                              example: Remember to do xyz
                              maxLength: 250
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 notes for an employment.
      tags:
        - Employment notes
    post:
      description: |
        __Activity name :__ PostEmploymentNoteByEmploymentId

        __Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.

        __Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostEmploymentNoteByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                accessibleBy:
                  description: |
                    Indicates who can view this node.
                  nullable: false
                  properties:
                    key:
                      description: The key for accessible by
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: Description of the accessible by
                      example: Everyone
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                createdBy:
                  format: metadata
                  nullable: true
                  properties:
                    formattedName:
                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                createdOn:
                  description: |
                    The date on which the note was created
                  example: 2018-01-01
                  format: date-time
                  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
                lastModifiedBy:
                  format: metadata
                  nullable: true
                  properties:
                    formattedName:
                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                lastModifiedOn:
                  description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                  example: 2018-01-01
                  format: date-time
                  nullable: false
                  readOnly: true
                  type: string
                note:
                  description: |-
                    The note it self.

                    __Note:__ This is a free text field so users can add htlm/script etc.
                  example: Remember to do xyz
                  maxLength: 4000
                  nullable: true
                  readOnly: false
                  type: string
                subject:
                  description: subject of the note
                  example: Remember to do xyz
                  maxLength: 250
                  nullable: false
                  readOnly: false
                  type: string
              type: object
        description: Add a note
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          accessibleBy:
                            description: |
                              Indicates who can view this node.
                            nullable: false
                            properties:
                              key:
                                description: The key for accessible by
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: Description of the accessible by
                                example: Everyone
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          createdBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          createdOn:
                            description: |
                              The date on which the note was created
                            example: 2018-01-01
                            format: date-time
                            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
                          lastModifiedBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          lastModifiedOn:
                            description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                            example: 2018-01-01
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          note:
                            description: |-
                              The note it self.

                              __Note:__ This is a free text field so users can add htlm/script etc.
                            example: Remember to do xyz
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          subject:
                            description: subject of the note
                            example: Remember to do xyz
                            maxLength: 250
                            nullable: false
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 note for an employment
      tags:
        - Employment notes
  "/providers/employers/employees/employments/{employmentId}/organizationalentities":
    get:
      description: |
        __Activity name:__ GetOrganizationalEntitiesByEmploymentId
            

        Get the list of organizational entities for an employment
      operationId: GetOrganizationalEntitiesByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            department:
                              description: |-
                                The department of the employment.

                                `department` is a metadata field within the employer context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                code:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                description:
                                  example: Verkoop
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  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
                              type: object
                            deviatingFunctionDescription:
                              description: The deviating function description of the employment. This description deviates from the value of the `function` field.
                              example: Directeur
                              maxLength: 50
                              nullable: true
                              readOnly: false
                              type: string
                            deviatingFunctionGroup:
                              description: The deviating function group description of the employment. Only applies when a deviating function description is defined.
                              example: 9A
                              maxLength: 5
                              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.

                                `distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                code:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                description:
                                  example: Sales
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  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
                              type: object
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              format: date
                              nullable: true
                              readOnly: true
                              type: string
                            function:
                              description: |-
                                The function of the employment.

                                `function` is a metadata field within the employer context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                description:
                                  example: Directeur
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                                group:
                                  example: internal
                                  maxLength: 5
                                  nullable: true
                                  readOnly: true
                                  type: string
                                key:
                                  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
                              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
                            internalTelephoneExtensionNumber:
                              description: The phone number of the standard working location (standplaats) for the employment.
                              example: "678"
                              maxLength: 15
                              nullable: true
                              readOnly: false
                              type: string
                            placeOfEmployment:
                              description: The standard working location (standplaats) for the employment.
                              example: Amsterdam office
                              maxLength: 24
                              nullable: true
                              readOnly: false
                              type: string
                            standardFunction:
                              description: |-
                                The standard (cao)function of the employment.

                                `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
                            startDate:
                              description: |-
                                The start date of the entity.

                                A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                              example: 2018-01-01
                              format: date
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 organizational entities for an employment
      tags:
        - Organizational entity
    post:
      description: |
        __Activity name:__ PostOrganizationalEntityByEmploymentId
            

        Create an organizational entity for an employment

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostOrganizationalEntityByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                department:
                  description: |-
                    The department of the employment.

                    `department` is a metadata field within the employer context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    code:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    description:
                      example: Verkoop
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      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
                  type: object
                deviatingFunctionDescription:
                  description: The deviating function description of the employment. This description deviates from the value of the `function` field.
                  example: Directeur
                  maxLength: 50
                  nullable: true
                  readOnly: false
                  type: string
                deviatingFunctionGroup:
                  description: The deviating function group description of the employment. Only applies when a deviating function description is defined.
                  example: 9A
                  maxLength: 5
                  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.

                    `distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    code:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    description:
                      example: Sales
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      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
                  type: object
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: true
                  type: string
                function:
                  description: |-
                    The function of the employment.

                    `function` is a metadata field within the employer context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    description:
                      example: Directeur
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                    group:
                      example: internal
                      maxLength: 5
                      nullable: true
                      readOnly: true
                      type: string
                    key:
                      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
                  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
                internalTelephoneExtensionNumber:
                  description: The phone number of the standard working location (standplaats) for the employment.
                  example: "678"
                  maxLength: 15
                  nullable: true
                  readOnly: false
                  type: string
                placeOfEmployment:
                  description: The standard working location (standplaats) for the employment.
                  example: Amsterdam office
                  maxLength: 24
                  nullable: true
                  readOnly: false
                  type: string
                standardFunction:
                  description: |-
                    The standard (cao)function of the employment.

                    `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
                startDate:
                  description: |-
                    The start date of the entity.

                    A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
        description: Organizational entity to add to the employment.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          department:
                            description: |-
                              The department of the employment.

                              `department` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              code:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              description:
                                example: Verkoop
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                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
                            type: object
                          deviatingFunctionDescription:
                            description: The deviating function description of the employment. This description deviates from the value of the `function` field.
                            example: Directeur
                            maxLength: 50
                            nullable: true
                            readOnly: false
                            type: string
                          deviatingFunctionGroup:
                            description: The deviating function group description of the employment. Only applies when a deviating function description is defined.
                            example: 9A
                            maxLength: 5
                            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.

                              `distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              code:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              description:
                                example: Sales
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                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
                            type: object
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          function:
                            description: |-
                              The function of the employment.

                              `function` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Directeur
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                              group:
                                example: internal
                                maxLength: 5
                                nullable: true
                                readOnly: true
                                type: string
                              key:
                                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
                            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
                          internalTelephoneExtensionNumber:
                            description: The phone number of the standard working location (standplaats) for the employment.
                            example: "678"
                            maxLength: 15
                            nullable: true
                            readOnly: false
                            type: string
                          placeOfEmployment:
                            description: The standard working location (standplaats) for the employment.
                            example: Amsterdam office
                            maxLength: 24
                            nullable: true
                            readOnly: false
                            type: string
                          standardFunction:
                            description: |-
                              The standard (cao)function of the employment.

                              `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
                          startDate:
                            description: |-
                              The start date of the entity.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 organizational entity for an employment
      tags:
        - Organizational entity
  "/providers/employers/employees/employments/{employmentId}/otherPayrollVariables":
    get:
      description: |
        __Activity name :__ GetOtherPayrollVariablesByEmploymentId

        Get a list of the other payroll variables for an employment Other payroll variables are a set of infrequently used properties for the payroll (wage tax and pension) proces
      operationId: GetOtherPayrollVariablesByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              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
                            insuranceProperties:
                              properties:
                                applicableForNoRiskPolicy:
                                  description: |-
                                    Indicates if the employment is applicable for the "Looncompensatie bij ziekte (no-riskpolis)" as defined by the UWV.

                                    Please check with the UWV to determine when to set the value to true.
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                              type: object
                            payrollProperties:
                              properties:
                                applyMinimumWageVocationalLearningPathway:
                                  description: Minimum wage vocational learning pathway (Minimumloon BBL) <to do>
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                applyYearlyHoursNorm:
                                  description: applyYearlyHoursNorm (jaarurennorm) indicates if the contract is based on a set numbers of hours per year and a set wage is payed every payroll period.
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                collectiveLaborAgreementCodeHiringEmployer:
                                  description: |-
                                    "CAO code inlener" The CAO code to be used in the payrolltax taxreturn for an employment that is "hired through agents" / " hired through an intermediary/third party".
                                    For more information when to set this value please check "Gegevensspecificaties aangifte loonheffingen 2020 v2.0 11 juli 2019"
                                  format: metadata
                                  nullable: true
                                  properties:
                                    endDate:
                                      description: The end date of the CAO
                                      example: 2018-10-23
                                      format: date
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    key:
                                      example: 151
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    startDate:
                                      description: The start date of the CAO
                                      example: 2018-01-01
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    value:
                                      example: TUINBOUWVEILINGEN
                                      maxLength: 90
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                deviatingPremiumGroup:
                                  description: Deviating premium group (Afwijkende premiegroep sectorfonds), indicates what deviating premie sector funds applies to 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: (1) Agrarisch bedrijf kort
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                incidentalIncomeDeduction:
                                  description: |-
                                    Incidental income deduction (Incidentele inkomstenvermindering) <to do>

                                    Indien gebruik gemaakt wordt van onbetaald verlof en/of ziekte uren dan wordt automatisch de code incidentele inkomstenvermindering in de loonaangifte bepaald (rubriek in de loonaangifte welke aangeeft dat het loon door ziekte of onbetaald verlof tijdelijk lager is dan het overeengekomen loon). In overige gevallen kan loket.nl niet automatisch bepalen of er sprake is van een incidentele inkomstenvermindering.  In deze rubriek dient dan de juiste waarde ingevuld te worden
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Bevalling of zwangerschap
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                occupationalDisabilityDeductionAfter2009:
                                  description: |-
                                    (OccupationalDisability) Deduction after 2009 (Arbeidsgeh.krt na 2009 (tm 2009 WAO)) <to do>
                                    Tot en met 2009 moest de premiekorting arbeidsgehandicapte werknemers gesplitst worden in een gedeelte voor de premie WAO/WIA en een gedeelte voor de premie WW-awf of UFO premie. Vanaf 2010 hoeft u het totaalbedrag niet meer te splitsen. Loket.nl zal de bedragen die opgegeven zijn bij Arbeidsgeh.krt na 2009 (tm 2009 WAO) en Arbeidsgeh. krt (tm 2009 AWF/UFO) bij elkaar optellen. U kunt vanaf 2010 dus volstaan met het vullen van Arbeidsgeh.krt na 2009 (tm 2009 WAO). Vanaf 2013 mag dit veld geen waarde meer bevatten, premiekorting arbeidsgehandicapte werknemer wordt automatisch bepaald op basis van opgegeven indicatie bij veld premiekorting
                                  example: 1
                                  format: double
                                  maximum: 9999.99
                                  minimum: 0.01
                                  nullable: true
                                  readOnly: false
                                  type: number
                                occupationalDisabilityDeductionTo2009:
                                  description: |-
                                    (OccupationalDisability) Deduction to 2009 (including 2009) (Arbeidsgeh.krt (tm 2009 AWF/UFO))
                                    Tot en met 2009 moest de premiekorting arbeidsgehandicapte werknemers gesplitst worden in een gedeelte voor de premie WAO/WIA en een gedeelte voor de premie WW-awf of UFO premie. Vanaf 2010 hoeft u het totaalbedrag niet meer te splitsen. Loket.nl zal de bedragen die opgegeven zijn bij Arbeidsgeh.krt na 2009 (tm 2009 WAO) en Arbeidsgeh. krt (tm 2009 AWF/UFO) bij elkaar optellen. U kunt vanaf 2010 dus volstaan met het vullen van Arbeidsgeh.krt na 2009 (tm 2009 WAO). Vanaf 2013 mag dit veld geen waarde meer bevatten, premiekorting arbeidsgehandicapte werknemer wordt automatisch bepaald op basis van opgegeven indicatie bij veld premiekorting
                                  example: 1
                                  format: double
                                  maximum: 9999.99
                                  minimum: 0.01
                                  nullable: true
                                  readOnly: false
                                  type: number
                                occupationalDisabilityPremiumDiscount:
                                  description: |-
                                    Occupational disability premium discount (arbeidsgehandicaptenkorting) not to be used after 2017. It indicates if "arbeidsgehandicaptenkorting" is applicable to this employment.

                                    Indicatie die aangeeft of er arbeidsgehandicaptenkorting of korting in dienst nemen van ouderen werknemer van toepassing is. Loket.nl zal bij invulling automatisch de juiste kortingen berekenen. Vanaf 2013 zijn alleen nog de codes 5 en 6 van toepassing. Indien codes 1 t/m 4 zijn ingevuld in 2013 dan interpreteert loket.nl als code 5.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: (7) Werknemer van 62, 63 of 64 jaar voor wie code 6 niet van toepassing is
                                      maxLength: 80
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                phaseClassification:
                                  description: |-
                                    Phase classification (Fase indeling) <to do>

                                    Indicatie die aangeeft in welke fase de inkomstenverhouding voor bepaalde tijd zich bevindt in het kader van de Wet Flexibiliteit en Zekerheid.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: (38) Fase A zonder uitzendbeding met uitsluiting van ldv
                                      maxLength: 60
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                terminateIncomenumberFlexibleEmployment:
                                  description: Terminate incomenumber flexible employment (Einde inkomstenverh.Flexwerker) <to do>
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: (1) Einde werk/contract, geen werk aangeboden
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                wageCostBenefit:
                                  description: |-
                                    Wage cost benefit (loonkostenvoordeel (LKV)). If applicable select the correct option to reduces the costs for an employer to employ the employee. 

                                    __UWV:__ Het loonkostenvoordeel (LKV) is een onderdeel van de Wet tegemoetkomingen loondomein (Wtl). Het LKV is een tegemoetkoming voor werkgevers die 1 of meer oudere werknemers en/of werknemers met een arbeidsbeperking in dienst nemen of houden.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: LKV herplaatsen arbeidsgehandicapte werknemer
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                wajongWithWageDispensation:
                                  description: wajongWithDispensation  (Wajong met loondispensatie (was Doelgroep banenafspraak)) indicates that the employer has the express premission to lower the wage of this employment (even below minimum wage). This indicator will disable the validation on minimum wage for this employment.
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                              type: object
                            pensionProperties:
                              properties:
                                annualCalculationBaseAbp:
                                  description: annualCalculationBase (jaargrondslag voor ABP) for ABP <to do>
                                  example: 1.5
                                  format: double
                                  maximum: 999999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,6})(\.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                applyDispensationRiskFund:
                                  description: applyDispensationRiskFund (Disp. risicofonds) <to do>
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                compulsoryEducationDays:
                                  description: compulsoryEducationDays (Aantal dagen leerplicht) <to do>
                                  example: 2
                                  format: int32
                                  maximum: 2
                                  minimum: 1
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                deviatingDisabilityInsuranceActPercentageForCordares:
                                  description: deviatingDisabilityInsuranceActPercentageForCordares (WAO % Cordares) used for Cordares. <to do>
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: 15- 25 %
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                leaveAbp:
                                  description: If both `leaveType` and `valueOfParticipationDuringLeave` are empty this parent object will be set to null. The same holds true when puting or posting this object. set `leaveAbp` to null when both `leaveType` and `valueOfParticipationDuringLeave` don't have a value
                                  nullable: true
                                  properties:
                                    leaveType:
                                      description: Leave type (Verlofsoort ABP) for ABP. <to do>
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          example: 2
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                        value:
                                          example: Politiek verlof
                                          maxLength: 50
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      type: object
                                    valueOfParticipationDuringLeave:
                                      description: valueOfParticipation (waardeDeelnemerschap) (pensioen opbouw voor ambtenaren ABP)
                                      example: 1
                                      format: int32
                                      maximum: 100
                                      minimum: 1
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                occupationalPensionFund:
                                  description: Occupational Pension Fund (BPF-code) <to do>
                                  example: 2
                                  format: int32
                                  maximum: 99
                                  minimum: 1
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                specificationOfIncomeRelationshipApg:
                                  description: specificationOfIncomeRelationship (APGVerbijzonderingInkomstenverhouding) used for the APG pension fund. <to do>
                                  format: metadata
                                  nullable: true
                                  properties:
                                    code:
                                      example: WNE
                                      maxLength: 4
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Geen bijzonderheden
                                      maxLength: 75
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                              type: object
                            productivityPercentage:
                              description: productivityPercentage (Productiviteitspercentage) can be used to indicate the productivity percentage of an employment.
                              example: 100
                              format: double
                              maximum: 100
                              minimum: 0
                              nullable: false
                              pattern: ^(\d{1,3})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            startDate:
                              description: |-
                                The date on which this record starts.

                                A (broken chain)[./#section/Data/Date-chains] is maintained with this record.
                              example: 2018-01-01
                              format: date
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 other payroll variables for an employment
      tags:
        - Other payroll variables
    post:
      description: |
        __Activity name :__ PostOtherPayrollVariablesByEmploymentId

        Add other payroll variables for an employment.
        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostOtherPayrollVariablesByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  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
                insuranceProperties:
                  properties:
                    applicableForNoRiskPolicy:
                      description: |-
                        Indicates if the employment is applicable for the "Looncompensatie bij ziekte (no-riskpolis)" as defined by the UWV.

                        Please check with the UWV to determine when to set the value to true.
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                  type: object
                payrollProperties:
                  properties:
                    applyMinimumWageVocationalLearningPathway:
                      description: Minimum wage vocational learning pathway (Minimumloon BBL) <to do>
                      nullable: false
                      readOnly: false
                      type: boolean
                    applyYearlyHoursNorm:
                      description: applyYearlyHoursNorm (jaarurennorm) indicates if the contract is based on a set numbers of hours per year and a set wage is payed every payroll period.
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                    collectiveLaborAgreementCodeHiringEmployer:
                      description: |-
                        "CAO code inlener" The CAO code to be used in the payrolltax taxreturn for an employment that is "hired through agents" / " hired through an intermediary/third party".
                        For more information when to set this value please check "Gegevensspecificaties aangifte loonheffingen 2020 v2.0 11 juli 2019"
                      format: metadata
                      nullable: true
                      properties:
                        endDate:
                          description: The end date of the CAO
                          example: 2018-10-23
                          format: date
                          nullable: true
                          readOnly: true
                          type: string
                        key:
                          example: 151
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        startDate:
                          description: The start date of the CAO
                          example: 2018-01-01
                          format: date
                          nullable: false
                          readOnly: true
                          type: string
                        value:
                          example: TUINBOUWVEILINGEN
                          maxLength: 90
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    deviatingPremiumGroup:
                      description: Deviating premium group (Afwijkende premiegroep sectorfonds), indicates what deviating premie sector funds applies to 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: (1) Agrarisch bedrijf kort
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    incidentalIncomeDeduction:
                      description: |-
                        Incidental income deduction (Incidentele inkomstenvermindering) <to do>

                        Indien gebruik gemaakt wordt van onbetaald verlof en/of ziekte uren dan wordt automatisch de code incidentele inkomstenvermindering in de loonaangifte bepaald (rubriek in de loonaangifte welke aangeeft dat het loon door ziekte of onbetaald verlof tijdelijk lager is dan het overeengekomen loon). In overige gevallen kan loket.nl niet automatisch bepalen of er sprake is van een incidentele inkomstenvermindering.  In deze rubriek dient dan de juiste waarde ingevuld te worden
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: Bevalling of zwangerschap
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    occupationalDisabilityDeductionAfter2009:
                      description: |-
                        (OccupationalDisability) Deduction after 2009 (Arbeidsgeh.krt na 2009 (tm 2009 WAO)) <to do>
                        Tot en met 2009 moest de premiekorting arbeidsgehandicapte werknemers gesplitst worden in een gedeelte voor de premie WAO/WIA en een gedeelte voor de premie WW-awf of UFO premie. Vanaf 2010 hoeft u het totaalbedrag niet meer te splitsen. Loket.nl zal de bedragen die opgegeven zijn bij Arbeidsgeh.krt na 2009 (tm 2009 WAO) en Arbeidsgeh. krt (tm 2009 AWF/UFO) bij elkaar optellen. U kunt vanaf 2010 dus volstaan met het vullen van Arbeidsgeh.krt na 2009 (tm 2009 WAO). Vanaf 2013 mag dit veld geen waarde meer bevatten, premiekorting arbeidsgehandicapte werknemer wordt automatisch bepaald op basis van opgegeven indicatie bij veld premiekorting
                      example: 1
                      format: double
                      maximum: 9999.99
                      minimum: 0.01
                      nullable: true
                      readOnly: false
                      type: number
                    occupationalDisabilityDeductionTo2009:
                      description: |-
                        (OccupationalDisability) Deduction to 2009 (including 2009) (Arbeidsgeh.krt (tm 2009 AWF/UFO))
                        Tot en met 2009 moest de premiekorting arbeidsgehandicapte werknemers gesplitst worden in een gedeelte voor de premie WAO/WIA en een gedeelte voor de premie WW-awf of UFO premie. Vanaf 2010 hoeft u het totaalbedrag niet meer te splitsen. Loket.nl zal de bedragen die opgegeven zijn bij Arbeidsgeh.krt na 2009 (tm 2009 WAO) en Arbeidsgeh. krt (tm 2009 AWF/UFO) bij elkaar optellen. U kunt vanaf 2010 dus volstaan met het vullen van Arbeidsgeh.krt na 2009 (tm 2009 WAO). Vanaf 2013 mag dit veld geen waarde meer bevatten, premiekorting arbeidsgehandicapte werknemer wordt automatisch bepaald op basis van opgegeven indicatie bij veld premiekorting
                      example: 1
                      format: double
                      maximum: 9999.99
                      minimum: 0.01
                      nullable: true
                      readOnly: false
                      type: number
                    occupationalDisabilityPremiumDiscount:
                      description: |-
                        Occupational disability premium discount (arbeidsgehandicaptenkorting) not to be used after 2017. It indicates if "arbeidsgehandicaptenkorting" is applicable to this employment.

                        Indicatie die aangeeft of er arbeidsgehandicaptenkorting of korting in dienst nemen van ouderen werknemer van toepassing is. Loket.nl zal bij invulling automatisch de juiste kortingen berekenen. Vanaf 2013 zijn alleen nog de codes 5 en 6 van toepassing. Indien codes 1 t/m 4 zijn ingevuld in 2013 dan interpreteert loket.nl als code 5.
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: (7) Werknemer van 62, 63 of 64 jaar voor wie code 6 niet van toepassing is
                          maxLength: 80
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    phaseClassification:
                      description: |-
                        Phase classification (Fase indeling) <to do>

                        Indicatie die aangeeft in welke fase de inkomstenverhouding voor bepaalde tijd zich bevindt in het kader van de Wet Flexibiliteit en Zekerheid.
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: (38) Fase A zonder uitzendbeding met uitsluiting van ldv
                          maxLength: 60
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    terminateIncomenumberFlexibleEmployment:
                      description: Terminate incomenumber flexible employment (Einde inkomstenverh.Flexwerker) <to do>
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: (1) Einde werk/contract, geen werk aangeboden
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    wageCostBenefit:
                      description: |-
                        Wage cost benefit (loonkostenvoordeel (LKV)). If applicable select the correct option to reduces the costs for an employer to employ the employee. 

                        __UWV:__ Het loonkostenvoordeel (LKV) is een onderdeel van de Wet tegemoetkomingen loondomein (Wtl). Het LKV is een tegemoetkoming voor werkgevers die 1 of meer oudere werknemers en/of werknemers met een arbeidsbeperking in dienst nemen of houden.
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: LKV herplaatsen arbeidsgehandicapte werknemer
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    wajongWithWageDispensation:
                      description: wajongWithDispensation  (Wajong met loondispensatie (was Doelgroep banenafspraak)) indicates that the employer has the express premission to lower the wage of this employment (even below minimum wage). This indicator will disable the validation on minimum wage for this employment.
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                  type: object
                pensionProperties:
                  properties:
                    annualCalculationBaseAbp:
                      description: annualCalculationBase (jaargrondslag voor ABP) for ABP <to do>
                      example: 1.5
                      format: double
                      maximum: 999999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,6})(\.\d{1,2})?$
                      readOnly: false
                      type: number
                    applyDispensationRiskFund:
                      description: applyDispensationRiskFund (Disp. risicofonds) <to do>
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                    compulsoryEducationDays:
                      description: compulsoryEducationDays (Aantal dagen leerplicht) <to do>
                      example: 2
                      format: int32
                      maximum: 2
                      minimum: 1
                      nullable: true
                      readOnly: false
                      type: integer
                    deviatingDisabilityInsuranceActPercentageForCordares:
                      description: deviatingDisabilityInsuranceActPercentageForCordares (WAO % Cordares) used for Cordares. <to do>
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: 15- 25 %
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    leaveAbp:
                      description: If both `leaveType` and `valueOfParticipationDuringLeave` are empty this parent object will be set to null. The same holds true when puting or posting this object. set `leaveAbp` to null when both `leaveType` and `valueOfParticipationDuringLeave` don't have a value
                      nullable: true
                      properties:
                        leaveType:
                          description: Leave type (Verlofsoort ABP) for ABP. <to do>
                          format: metadata
                          nullable: false
                          properties:
                            key:
                              example: 2
                              format: int32
                              nullable: false
                              readOnly: false
                              type: integer
                            value:
                              example: Politiek verlof
                              maxLength: 50
                              nullable: false
                              readOnly: true
                              type: string
                          type: object
                        valueOfParticipationDuringLeave:
                          description: valueOfParticipation (waardeDeelnemerschap) (pensioen opbouw voor ambtenaren ABP)
                          example: 1
                          format: int32
                          maximum: 100
                          minimum: 1
                          nullable: false
                          readOnly: false
                          type: integer
                      type: object
                    occupationalPensionFund:
                      description: Occupational Pension Fund (BPF-code) <to do>
                      example: 2
                      format: int32
                      maximum: 99
                      minimum: 1
                      nullable: true
                      readOnly: false
                      type: integer
                    specificationOfIncomeRelationshipApg:
                      description: specificationOfIncomeRelationship (APGVerbijzonderingInkomstenverhouding) used for the APG pension fund. <to do>
                      format: metadata
                      nullable: true
                      properties:
                        code:
                          example: WNE
                          maxLength: 4
                          nullable: false
                          readOnly: true
                          type: string
                        key:
                          example: 1
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: Geen bijzonderheden
                          maxLength: 75
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                  type: object
                productivityPercentage:
                  description: productivityPercentage (Productiviteitspercentage) can be used to indicate the productivity percentage of an employment.
                  example: 100
                  format: double
                  maximum: 100
                  minimum: 0
                  nullable: false
                  pattern: ^(\d{1,3})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                startDate:
                  description: |-
                    The date on which this record starts.

                    A (broken chain)[./#section/Data/Date-chains] is maintained with this record.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
        description: Add other payroll variables for an employment
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            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
                          insuranceProperties:
                            properties:
                              applicableForNoRiskPolicy:
                                description: |-
                                  Indicates if the employment is applicable for the "Looncompensatie bij ziekte (no-riskpolis)" as defined by the UWV.

                                  Please check with the UWV to determine when to set the value to true.
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                            type: object
                          payrollProperties:
                            properties:
                              applyMinimumWageVocationalLearningPathway:
                                description: Minimum wage vocational learning pathway (Minimumloon BBL) <to do>
                                nullable: false
                                readOnly: false
                                type: boolean
                              applyYearlyHoursNorm:
                                description: applyYearlyHoursNorm (jaarurennorm) indicates if the contract is based on a set numbers of hours per year and a set wage is payed every payroll period.
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              collectiveLaborAgreementCodeHiringEmployer:
                                description: |-
                                  "CAO code inlener" The CAO code to be used in the payrolltax taxreturn for an employment that is "hired through agents" / " hired through an intermediary/third party".
                                  For more information when to set this value please check "Gegevensspecificaties aangifte loonheffingen 2020 v2.0 11 juli 2019"
                                format: metadata
                                nullable: true
                                properties:
                                  endDate:
                                    description: The end date of the CAO
                                    example: 2018-10-23
                                    format: date
                                    nullable: true
                                    readOnly: true
                                    type: string
                                  key:
                                    example: 151
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  startDate:
                                    description: The start date of the CAO
                                    example: 2018-01-01
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  value:
                                    example: TUINBOUWVEILINGEN
                                    maxLength: 90
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              deviatingPremiumGroup:
                                description: Deviating premium group (Afwijkende premiegroep sectorfonds), indicates what deviating premie sector funds applies to 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: (1) Agrarisch bedrijf kort
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              incidentalIncomeDeduction:
                                description: |-
                                  Incidental income deduction (Incidentele inkomstenvermindering) <to do>

                                  Indien gebruik gemaakt wordt van onbetaald verlof en/of ziekte uren dan wordt automatisch de code incidentele inkomstenvermindering in de loonaangifte bepaald (rubriek in de loonaangifte welke aangeeft dat het loon door ziekte of onbetaald verlof tijdelijk lager is dan het overeengekomen loon). In overige gevallen kan loket.nl niet automatisch bepalen of er sprake is van een incidentele inkomstenvermindering.  In deze rubriek dient dan de juiste waarde ingevuld te worden
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Bevalling of zwangerschap
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              occupationalDisabilityDeductionAfter2009:
                                description: |-
                                  (OccupationalDisability) Deduction after 2009 (Arbeidsgeh.krt na 2009 (tm 2009 WAO)) <to do>
                                  Tot en met 2009 moest de premiekorting arbeidsgehandicapte werknemers gesplitst worden in een gedeelte voor de premie WAO/WIA en een gedeelte voor de premie WW-awf of UFO premie. Vanaf 2010 hoeft u het totaalbedrag niet meer te splitsen. Loket.nl zal de bedragen die opgegeven zijn bij Arbeidsgeh.krt na 2009 (tm 2009 WAO) en Arbeidsgeh. krt (tm 2009 AWF/UFO) bij elkaar optellen. U kunt vanaf 2010 dus volstaan met het vullen van Arbeidsgeh.krt na 2009 (tm 2009 WAO). Vanaf 2013 mag dit veld geen waarde meer bevatten, premiekorting arbeidsgehandicapte werknemer wordt automatisch bepaald op basis van opgegeven indicatie bij veld premiekorting
                                example: 1
                                format: double
                                maximum: 9999.99
                                minimum: 0.01
                                nullable: true
                                readOnly: false
                                type: number
                              occupationalDisabilityDeductionTo2009:
                                description: |-
                                  (OccupationalDisability) Deduction to 2009 (including 2009) (Arbeidsgeh.krt (tm 2009 AWF/UFO))
                                  Tot en met 2009 moest de premiekorting arbeidsgehandicapte werknemers gesplitst worden in een gedeelte voor de premie WAO/WIA en een gedeelte voor de premie WW-awf of UFO premie. Vanaf 2010 hoeft u het totaalbedrag niet meer te splitsen. Loket.nl zal de bedragen die opgegeven zijn bij Arbeidsgeh.krt na 2009 (tm 2009 WAO) en Arbeidsgeh. krt (tm 2009 AWF/UFO) bij elkaar optellen. U kunt vanaf 2010 dus volstaan met het vullen van Arbeidsgeh.krt na 2009 (tm 2009 WAO). Vanaf 2013 mag dit veld geen waarde meer bevatten, premiekorting arbeidsgehandicapte werknemer wordt automatisch bepaald op basis van opgegeven indicatie bij veld premiekorting
                                example: 1
                                format: double
                                maximum: 9999.99
                                minimum: 0.01
                                nullable: true
                                readOnly: false
                                type: number
                              occupationalDisabilityPremiumDiscount:
                                description: |-
                                  Occupational disability premium discount (arbeidsgehandicaptenkorting) not to be used after 2017. It indicates if "arbeidsgehandicaptenkorting" is applicable to this employment.

                                  Indicatie die aangeeft of er arbeidsgehandicaptenkorting of korting in dienst nemen van ouderen werknemer van toepassing is. Loket.nl zal bij invulling automatisch de juiste kortingen berekenen. Vanaf 2013 zijn alleen nog de codes 5 en 6 van toepassing. Indien codes 1 t/m 4 zijn ingevuld in 2013 dan interpreteert loket.nl als code 5.
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: (7) Werknemer van 62, 63 of 64 jaar voor wie code 6 niet van toepassing is
                                    maxLength: 80
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              phaseClassification:
                                description: |-
                                  Phase classification (Fase indeling) <to do>

                                  Indicatie die aangeeft in welke fase de inkomstenverhouding voor bepaalde tijd zich bevindt in het kader van de Wet Flexibiliteit en Zekerheid.
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: (38) Fase A zonder uitzendbeding met uitsluiting van ldv
                                    maxLength: 60
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              terminateIncomenumberFlexibleEmployment:
                                description: Terminate incomenumber flexible employment (Einde inkomstenverh.Flexwerker) <to do>
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: (1) Einde werk/contract, geen werk aangeboden
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              wageCostBenefit:
                                description: |-
                                  Wage cost benefit (loonkostenvoordeel (LKV)). If applicable select the correct option to reduces the costs for an employer to employ the employee. 

                                  __UWV:__ Het loonkostenvoordeel (LKV) is een onderdeel van de Wet tegemoetkomingen loondomein (Wtl). Het LKV is een tegemoetkoming voor werkgevers die 1 of meer oudere werknemers en/of werknemers met een arbeidsbeperking in dienst nemen of houden.
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: LKV herplaatsen arbeidsgehandicapte werknemer
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              wajongWithWageDispensation:
                                description: wajongWithDispensation  (Wajong met loondispensatie (was Doelgroep banenafspraak)) indicates that the employer has the express premission to lower the wage of this employment (even below minimum wage). This indicator will disable the validation on minimum wage for this employment.
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                            type: object
                          pensionProperties:
                            properties:
                              annualCalculationBaseAbp:
                                description: annualCalculationBase (jaargrondslag voor ABP) for ABP <to do>
                                example: 1.5
                                format: double
                                maximum: 999999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,6})(\.\d{1,2})?$
                                readOnly: false
                                type: number
                              applyDispensationRiskFund:
                                description: applyDispensationRiskFund (Disp. risicofonds) <to do>
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              compulsoryEducationDays:
                                description: compulsoryEducationDays (Aantal dagen leerplicht) <to do>
                                example: 2
                                format: int32
                                maximum: 2
                                minimum: 1
                                nullable: true
                                readOnly: false
                                type: integer
                              deviatingDisabilityInsuranceActPercentageForCordares:
                                description: deviatingDisabilityInsuranceActPercentageForCordares (WAO % Cordares) used for Cordares. <to do>
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: 15- 25 %
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              leaveAbp:
                                description: If both `leaveType` and `valueOfParticipationDuringLeave` are empty this parent object will be set to null. The same holds true when puting or posting this object. set `leaveAbp` to null when both `leaveType` and `valueOfParticipationDuringLeave` don't have a value
                                nullable: true
                                properties:
                                  leaveType:
                                    description: Leave type (Verlofsoort ABP) for ABP. <to do>
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        example: 2
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        example: Politiek verlof
                                        maxLength: 50
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                  valueOfParticipationDuringLeave:
                                    description: valueOfParticipation (waardeDeelnemerschap) (pensioen opbouw voor ambtenaren ABP)
                                    example: 1
                                    format: int32
                                    maximum: 100
                                    minimum: 1
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                type: object
                              occupationalPensionFund:
                                description: Occupational Pension Fund (BPF-code) <to do>
                                example: 2
                                format: int32
                                maximum: 99
                                minimum: 1
                                nullable: true
                                readOnly: false
                                type: integer
                              specificationOfIncomeRelationshipApg:
                                description: specificationOfIncomeRelationship (APGVerbijzonderingInkomstenverhouding) used for the APG pension fund. <to do>
                                format: metadata
                                nullable: true
                                properties:
                                  code:
                                    example: WNE
                                    maxLength: 4
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  key:
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Geen bijzonderheden
                                    maxLength: 75
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                            type: object
                          productivityPercentage:
                            description: productivityPercentage (Productiviteitspercentage) can be used to indicate the productivity percentage of an employment.
                            example: 100
                            format: double
                            maximum: 100
                            minimum: 0
                            nullable: false
                            pattern: ^(\d{1,3})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          startDate:
                            description: |-
                              The date on which this record starts.

                              A (broken chain)[./#section/Data/Date-chains] is maintained with this record.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 other payroll variables for an employment
      tags:
        - Other payroll variables
  "/providers/employers/employees/employments/{employmentId}/paymentinformationnonsepa":
    get:
      description: |
        __Activity name :__ GetPaymentInformationNonSepaByEmploymentId

        Get a list of payment information for non-SEPA bank accounts for an employment. These are payments to be performed that will NOT be based on an IBAN (which is the standard), so this is mostly useful for foreign payments that are not based within a SEPA-country. 

        For a specific payroll component, the record indicates to which account payments will be made.  This includes, but is not limited to, the payment of wages for an employment.

        For each payroll component there can only be one payment Information record per employment.
      operationId: GetPaymentInformationNonSepaByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            bank:
                              description: Information regarding the bank coresponding with the bank account number
                              nullable: false
                              properties:
                                address:
                                  description: |
                                    Address of beneficiary bank
                                  example: Via Roma 3
                                  maxLength: 35
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                bankIdentifierCode:
                                  description: |
                                    BIC /SWIFT code for the bank
                                  example: AUDFDE21
                                  maxLength: 11
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                city:
                                  description: |
                                    City name of beneficiary bank
                                  example: Rome
                                  maxLength: 35
                                  minLength: 1
                                  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
                                name:
                                  description: |
                                    Name of benificiary bank
                                  example: Ben Hur
                                  maxLength: 35
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                              type: object
                            bankAccountNumber:
                              description: |
                                The bank account number
                              example: "0403830171874018"
                              maxLength: 34
                              minLength: 1
                              nullable: false
                              readOnly: false
                              type: string
                            beneficiary:
                              description: Information regarding the beneficiary coresponding with the bank account number
                              nullable: false
                              properties:
                                address:
                                  description: |
                                    Address of beneficiary
                                  example: Via Roma 3
                                  maxLength: 35
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                city:
                                  description: |
                                    City name of beneficiary
                                  example: Rome
                                  maxLength: 35
                                  minLength: 1
                                  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
                                name:
                                  description: |
                                    Name of the beneficiary
                                  example: Ben Hur
                                  maxLength: 35
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  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
                            payrollComponent:
                              description: |
                                The payroll component for which the outgoing payment records applies.
                                Each payroll component can only be used once per employment.

                                `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                              format: metaData
                              nullable: false
                              properties:
                                key:
                                  description: |
                                    The number for the payroll component
                                  example: 260
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    The description of the payroll component
                                  example: NETTOLOON
                                  maxLength: 14
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payment information non-SEPA
      tags:
        - Payment information non-SEPA
    post:
      description: |
        __Activity name :__ PostPaymentInformationNonSepaByEmploymentId

        Create a new payment information non-SEPA record for an employment. For each unique payroll component there can only be one payment information non-SEPA record per employment.

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

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostPaymentInformationNonSepaByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
          applicationjson;version=2018-01-01:
            schema:
              properties:
                bank:
                  description: Information regarding the bank coresponding with the bank account number
                  nullable: false
                  properties:
                    address:
                      description: |
                        Address of beneficiary bank
                      example: Via Roma 3
                      maxLength: 35
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    bankIdentifierCode:
                      description: |
                        BIC /SWIFT code for the bank
                      example: AUDFDE21
                      maxLength: 11
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    city:
                      description: |
                        City name of beneficiary bank
                      example: Rome
                      maxLength: 35
                      minLength: 1
                      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
                    name:
                      description: |
                        Name of benificiary bank
                      example: Ben Hur
                      maxLength: 35
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                  type: object
                bankAccountNumber:
                  description: |
                    The bank account number
                  example: "0403830171874018"
                  maxLength: 34
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                beneficiary:
                  description: Information regarding the beneficiary coresponding with the bank account number
                  nullable: false
                  properties:
                    address:
                      description: |
                        Address of beneficiary
                      example: Via Roma 3
                      maxLength: 35
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    city:
                      description: |
                        City name of beneficiary
                      example: Rome
                      maxLength: 35
                      minLength: 1
                      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
                    name:
                      description: |
                        Name of the beneficiary
                      example: Ben Hur
                      maxLength: 35
                      minLength: 1
                      nullable: false
                      readOnly: false
                      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
                payrollComponent:
                  description: |
                    The payroll component for which the outgoing payment records applies.
                    Each payroll component can only be used once per employment.

                    `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metaData
                  nullable: false
                  properties:
                    key:
                      description: |
                        The number for the payroll component
                      example: 260
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        The description of the payroll component
                      example: NETTOLOON
                      maxLength: 14
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
        description: Payment information non-SEPA record to add to the employment
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          bank:
                            description: Information regarding the bank coresponding with the bank account number
                            nullable: false
                            properties:
                              address:
                                description: |
                                  Address of beneficiary bank
                                example: Via Roma 3
                                maxLength: 35
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              bankIdentifierCode:
                                description: |
                                  BIC /SWIFT code for the bank
                                example: AUDFDE21
                                maxLength: 11
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              city:
                                description: |
                                  City name of beneficiary bank
                                example: Rome
                                maxLength: 35
                                minLength: 1
                                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
                              name:
                                description: |
                                  Name of benificiary bank
                                example: Ben Hur
                                maxLength: 35
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                            type: object
                          bankAccountNumber:
                            description: |
                              The bank account number
                            example: "0403830171874018"
                            maxLength: 34
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          beneficiary:
                            description: Information regarding the beneficiary coresponding with the bank account number
                            nullable: false
                            properties:
                              address:
                                description: |
                                  Address of beneficiary
                                example: Via Roma 3
                                maxLength: 35
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              city:
                                description: |
                                  City name of beneficiary
                                example: Rome
                                maxLength: 35
                                minLength: 1
                                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
                              name:
                                description: |
                                  Name of the beneficiary
                                example: Ben Hur
                                maxLength: 35
                                minLength: 1
                                nullable: false
                                readOnly: false
                                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
                          payrollComponent:
                            description: |
                              The payroll component for which the outgoing payment records applies.
                              Each payroll component can only be used once per employment.

                              `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metaData
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The number for the payroll component
                                example: 260
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description of the payroll component
                                example: NETTOLOON
                                maxLength: 14
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 new payment information non-SEPA record
      tags:
        - Payment information non-SEPA
  "/providers/employers/employees/employments/{employmentId}/paymentinformationsepa":
    get:
      description: |
        __Activity name :__ GetPaymentInformationSepaByEmploymentId

        Get a list of payment information for SEPA bank accounts (IBAN's) for an employment.
         
        For a specific payroll component, the record indicates to which IBAN payments will be made. 
        This includes, but is not limited to, the payment of wages for an employment.
         
        For each payroll component there can only be one payment information record per employment.
      operationId: GetPaymentInformationSepaByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            bic:
                              description: |
                                BIC /SWIFT code. Only applicable for a non-Dutch IBAN
                              example: AUDFDE21
                              maxLength: 11
                              minLength: 1
                              nullable: true
                              readOnly: false
                              type: string
                            cityBeneficiary:
                              description: |
                                City name of beneficiary.
                              example: Rome
                              maxLength: 24
                              minLength: 1
                              nullable: true
                              readOnly: false
                              type: string
                            description1:
                              description: |
                                Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                              example: xx
                              maxLength: 32
                              minLength: 1
                              nullable: true
                              readOnly: false
                              type: string
                            description2:
                              description: |
                                Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                              example: x
                              maxLength: 32
                              minLength: 1
                              nullable: true
                              readOnly: false
                              type: string
                            iban:
                              description: |
                                International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                              example: NL52ABNA0424968264
                              maxLength: 35
                              minLength: 1
                              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
                            nameBeneficiary:
                              description: |
                                Name of beneficiary.
                              example: Ben Hur
                              maxLength: 70
                              minLength: 1
                              nullable: true
                              readOnly: false
                              type: string
                            payrollComponent:
                              description: |
                                The payroll component for which the outgoing payment records applies.

                                `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                              format: metaData
                              nullable: false
                              properties:
                                key:
                                  example: 260
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: NETTOLOON
                                  maxLength: 50
                                  minLength: 0
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              type: object
                            visibleOnPayslip:
                              description: |
                                Indicates whether the payment-component is visible on a payslip.
                              example: true
                              nullable: false
                              readOnly: false
                              type: boolean
                        type: array
                    type: object
            application/json;version=YYYY-MM-DD:
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            beneficiary:
                              description: Information regarding the beneficiary coresponding with the bank account number
                              nullable: false
                              properties:
                                city:
                                  description: |
                                    City name of beneficiary.
                                  example: Rome
                                  maxLength: 24
                                  minLength: 1
                                  nullable: true
                                  readOnly: false
                                  type: string
                                name:
                                  description: |
                                    Name of beneficiary.
                                  example: Ben Hur
                                  maxLength: 70
                                  minLength: 1
                                  nullable: true
                                  readOnly: false
                                  type: string
                              type: object
                            bic:
                              description: |
                                BIC /SWIFT code. Only applicable for a non-Dutch IBAN
                              example: AUDFDE21
                              maxLength: 11
                              minLength: 0
                              nullable: true
                              readOnly: false
                              type: string
                            description1:
                              description: |
                                Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                              example: xx
                              maxLength: 32
                              minLength: 1
                              nullable: true
                              readOnly: false
                              type: string
                            description2:
                              description: |
                                Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                              example: x
                              maxLength: 32
                              minLength: 1
                              nullable: true
                              readOnly: false
                              type: string
                            iban:
                              description: |
                                International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                              example: NL52ABNA0424968264
                              maxLength: 35
                              minLength: 0
                              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
                            payrollComponent:
                              description: |
                                The payroll component for which the outgoing payment records applies.

                                `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                              format: metaData
                              nullable: false
                              properties:
                                description:
                                  example: NETTOLOON
                                  maxLength: 50
                                  minLength: 0
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  example: 260
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              readOnly: false
                              type: object
                            visibleOnPayslip:
                              description: |
                                Indicates whether the payment-component is visible on a payslip.
                              example: true
                              nullable: false
                              readOnly: false
                              type: boolean
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payment information sepa
      tags:
        - Payment information
    post:
      description: |
        __Activity name :__ PostPaymentInformationSepaByEmploymentId

        Create a new Payment information SEPA record for an employment.<br/> For each unique payroll component there can only be one payment record per employment.

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

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostPaymentInformationSepaByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
          applicationjson;version=2018-01-01:
            schema:
              properties:
                bic:
                  description: |
                    BIC /SWIFT code. Only applicable for a non-Dutch IBAN
                  example: AUDFDE21
                  maxLength: 11
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                cityBeneficiary:
                  description: |
                    City name of beneficiary.
                  example: Rome
                  maxLength: 24
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                description1:
                  description: |
                    Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                  example: xx
                  maxLength: 32
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                description2:
                  description: |
                    Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                  example: x
                  maxLength: 32
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                iban:
                  description: |
                    International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                  example: NL52ABNA0424968264
                  maxLength: 35
                  minLength: 1
                  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
                nameBeneficiary:
                  description: |
                    Name of beneficiary.
                  example: Ben Hur
                  maxLength: 70
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                payrollComponent:
                  description: |
                    The payroll component for which the outgoing payment records applies.

                    `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metaData
                  nullable: false
                  properties:
                    key:
                      example: 260
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: NETTOLOON
                      maxLength: 50
                      minLength: 0
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
                visibleOnPayslip:
                  description: |
                    Indicates whether the payment-component is visible on a payslip.
                  example: true
                  nullable: false
                  readOnly: false
                  type: boolean
          applicationjson;version=YYYY-MM-DD:
            schema:
              properties:
                beneficiary:
                  description: Information regarding the beneficiary coresponding with the bank account number
                  nullable: false
                  properties:
                    city:
                      description: |
                        City name of beneficiary.
                      example: Rome
                      maxLength: 24
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                    name:
                      description: |
                        Name of beneficiary.
                      example: Ben Hur
                      maxLength: 70
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                  type: object
                bic:
                  description: |
                    BIC /SWIFT code. Only applicable for a non-Dutch IBAN
                  example: AUDFDE21
                  maxLength: 11
                  minLength: 0
                  nullable: true
                  readOnly: false
                  type: string
                description1:
                  description: |
                    Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                  example: xx
                  maxLength: 32
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                description2:
                  description: |
                    Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                  example: x
                  maxLength: 32
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                iban:
                  description: |
                    International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                  example: NL52ABNA0424968264
                  maxLength: 35
                  minLength: 0
                  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
                payrollComponent:
                  description: |
                    The payroll component for which the outgoing payment records applies.

                    `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metaData
                  nullable: false
                  properties:
                    description:
                      example: NETTOLOON
                      maxLength: 50
                      minLength: 0
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      example: 260
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  readOnly: false
                  type: object
                visibleOnPayslip:
                  description: |
                    Indicates whether the payment-component is visible on a payslip.
                  example: true
                  nullable: false
                  readOnly: false
                  type: boolean
        description: Payment information sepa record to add to the employment
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          bic:
                            description: |
                              BIC /SWIFT code. Only applicable for a non-Dutch IBAN
                            example: AUDFDE21
                            maxLength: 11
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          cityBeneficiary:
                            description: |
                              City name of beneficiary.
                            example: Rome
                            maxLength: 24
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          description1:
                            description: |
                              Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: xx
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          description2:
                            description: |
                              Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: x
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          iban:
                            description: |
                              International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                            example: NL52ABNA0424968264
                            maxLength: 35
                            minLength: 1
                            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
                          nameBeneficiary:
                            description: |
                              Name of beneficiary.
                            example: Ben Hur
                            maxLength: 70
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          payrollComponent:
                            description: |
                              The payroll component for which the outgoing payment records applies.

                              `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metaData
                            nullable: false
                            properties:
                              key:
                                example: 260
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: NETTOLOON
                                maxLength: 50
                                minLength: 0
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          visibleOnPayslip:
                            description: |
                              Indicates whether the payment-component is visible on a payslip.
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                    type: object
            application/json;version=YYYY-MM-DD:
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          beneficiary:
                            description: Information regarding the beneficiary coresponding with the bank account number
                            nullable: false
                            properties:
                              city:
                                description: |
                                  City name of beneficiary.
                                example: Rome
                                maxLength: 24
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              name:
                                description: |
                                  Name of beneficiary.
                                example: Ben Hur
                                maxLength: 70
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                            type: object
                          bic:
                            description: |
                              BIC /SWIFT code. Only applicable for a non-Dutch IBAN
                            example: AUDFDE21
                            maxLength: 11
                            minLength: 0
                            nullable: true
                            readOnly: false
                            type: string
                          description1:
                            description: |
                              Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: xx
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          description2:
                            description: |
                              Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: x
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          iban:
                            description: |
                              International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                            example: NL52ABNA0424968264
                            maxLength: 35
                            minLength: 0
                            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
                          payrollComponent:
                            description: |
                              The payroll component for which the outgoing payment records applies.

                              `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metaData
                            nullable: false
                            properties:
                              description:
                                example: NETTOLOON
                                maxLength: 50
                                minLength: 0
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                example: 260
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            readOnly: false
                            type: object
                          visibleOnPayslip:
                            description: |
                              Indicates whether the payment-component is visible on a payslip.
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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 new payment information sepa record
      tags:
        - Payment information
  "/providers/employers/employees/employments/{employmentId}/paymentinformationsepaseparatepayments":
    get:
      description: |
        __Activity name :__ GetPaymentInformationSepaSeparatePaymentByEmploymentId

        Get a list of records that indicate, 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.
      operationId: GetPaymentInformationSepaSeparatePaymentByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            amount:
                              description: The amount to be split from the net salary
                              example: 32
                              format: double
                              maximum: 99999999.99
                              minimum: 0.01
                              nullable: false
                              pattern: ^(\d{1,8})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            cityBeneficiary:
                              description: |
                                City name of beneficiary
                              example: Rome
                              maxLength: 24
                              minLength: 1
                              nullable: true
                              readOnly: false
                              type: string
                            description1:
                              description: |
                                Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                              example: Savings to different account
                              maxLength: 32
                              minLength: 1
                              nullable: false
                              readOnly: false
                              type: string
                            description2:
                              description: |
                                Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                              example: from net wage
                              maxLength: 32
                              minLength: 1
                              nullable: true
                              readOnly: false
                              type: string
                            endDate:
                              description: |
                                The end date of the record
                              example: 2018-10-23
                              format: date
                              nullable: true
                              readOnly: false
                              type: string
                            iban:
                              description: |
                                International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                              example: NL52ABNA0424968264
                              maxLength: 35
                              minLength: 1
                              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
                            nameBeneficiary:
                              description: |
                                Name of beneficiary
                              example: Ben Hur
                              maxLength: 70
                              minLength: 1
                              nullable: false
                              readOnly: false
                              type: string
                            startDate:
                              description: |
                                Start date of this record

                                __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for splitting from net salary at that date (based on the start- and enddate).
                              example: 2018-01-01
                              format: date
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payment information SEPA separate payment records
      tags:
        - Payment information separate payments
    post:
      description: |
        __Activity name :__ PostPaymentInformationSepaSeparatePaymentByEmploymentId

        Create a new payment information SEPA separate payment record for an employment.<br/>

        __Metadata :__ Not applicable for this resource.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostPaymentInformationSepaSeparatePaymentByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
          applicationjson;version=2018-01-01:
            schema:
              properties:
                amount:
                  description: The amount to be split from the net salary
                  example: 32
                  format: double
                  maximum: 99999999.99
                  minimum: 0.01
                  nullable: false
                  pattern: ^(\d{1,8})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                cityBeneficiary:
                  description: |
                    City name of beneficiary
                  example: Rome
                  maxLength: 24
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                description1:
                  description: |
                    Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                  example: Savings to different account
                  maxLength: 32
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                description2:
                  description: |
                    Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                  example: from net wage
                  maxLength: 32
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                endDate:
                  description: |
                    The end date of the record
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                iban:
                  description: |
                    International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                  example: NL52ABNA0424968264
                  maxLength: 35
                  minLength: 1
                  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
                nameBeneficiary:
                  description: |
                    Name of beneficiary
                  example: Ben Hur
                  maxLength: 70
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                startDate:
                  description: |
                    Start date of this record

                    __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for splitting from net salary at that date (based on the start- and enddate).
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          amount:
                            description: The amount to be split from the net salary
                            example: 32
                            format: double
                            maximum: 99999999.99
                            minimum: 0.01
                            nullable: false
                            pattern: ^(\d{1,8})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          cityBeneficiary:
                            description: |
                              City name of beneficiary
                            example: Rome
                            maxLength: 24
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          description1:
                            description: |
                              Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: Savings to different account
                            maxLength: 32
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          description2:
                            description: |
                              Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.
                            example: from net wage
                            maxLength: 32
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          endDate:
                            description: |
                              The end date of the record
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          iban:
                            description: |
                              International Bank Account Number (IBAN). Only IBAN without spaces are accepted.
                            example: NL52ABNA0424968264
                            maxLength: 35
                            minLength: 1
                            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
                          nameBeneficiary:
                            description: |
                              Name of beneficiary
                            example: Ben Hur
                            maxLength: 70
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          startDate:
                            description: |
                              Start date of this record

                              __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for splitting from net salary at that date (based on the start- and enddate).
                            example: 2018-01-01
                            format: date
                            nullable: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 new payment information SEPA separate payment record
      tags:
        - Payment information separate payments
  "/providers/employers/employees/employments/{employmentId}/payrollSimulatorData":
    get:
      description: |
        __Activity name :__ GetPayrollSimulatorDataByEmploymentId

        Get an overview of the data used in a payroll simulation
      operationId: GetPayrollSimulatorDataByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          payrollPeriodType:
                            description: Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4).
                            nullable: false
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: month
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          startDateDeviations:
                            description: The date to be used when calling the wageprojection endpoint
                            example: 2022-08-01
                            format: date
                            nullable: false
                            readOnly: true
                            type: string
                          wage:
                            nullable: false
                            properties:
                              class:
                                description: The class of the wage
                                enum:
                                  - Basisloon
                                  - Nettoloon
                                  - Loonkosten
                                example: Basisloon
                                maxLength: 255
                                nullable: false
                                readOnly: true
                                type: string
                              currentWage:
                                description: |
                                  The gross wage for the employee
                                example: 2300
                                format: double
                                maximum: 999999.99
                                minimum: 0.01
                                nullable: true
                                readOnly: true
                                type: number
                              type:
                                description: |
                                  Indicates whether the `value` 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.
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  value:
                                    example: hourly
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                            type: object
                          workingHours:
                            properties:
                              currentHoursPerWeek:
                                description: The hours per week de employment currently works
                                example: 41
                                nullable: true
                                readOnly: true
                                type: number
                              shift:
                                description: |
                                  The shift determines the full-time hours and bonus percentage.

                                  `shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                nullable: false
                                properties:
                                  fullTimeHoursPerWeek:
                                    description: |
                                      The full time hours for an employment that is linked to this shift.
                                    example: 40
                                    maximum: 99
                                    minimum: 0.01
                                    nullable: false
                                    readOnly: true
                                    type: number
                                type: object
                            type: object
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Overview of the data used in a payroll simulation
      tags:
        - Payroll simulator
  "/providers/employers/employees/employments/{employmentId}/payrollperioddata":
    get:
      description: |
        __Activity name :__ GetPayrollPeriodDataByEmploymentId <br/> <br/> Get a list of all payroll period data for an employment. Payroll period data relates to a single payroll period.
      operationId: GetPayrollPeriodDataByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            costCenter:
                              description: |
                                The cost center on which the payroll period data for this record will be booked for the ledger.
                              format: metadata
                              nullable: true
                              properties:
                                code:
                                  example: SAL073
                                  nullable: false
                                  readOnly: true
                                  type: string
                                description:
                                  example: Sales Den Bosch
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            costUnit:
                              description: |
                                The cost unit on which the data for this record will be booked for the ledger
                              format: metadata
                              nullable: true
                              properties:
                                code:
                                  example: "01"
                                  nullable: false
                                  readOnly: true
                                  type: string
                                description:
                                  example: Cars
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            distributionUnit:
                              description: |
                                Distribution unit, used in several reports and the "basic wage journal" functionality. Commonly used as a cost center.
                              format: metadata
                              nullable: false
                              properties:
                                code:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                description:
                                  example: Sales
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  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
                              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
                            payrollComponents:
                              items:
                                properties:
                                  isSupplement:
                                    description: |
                                      This boolean determines what the salary calculation will do with the value of the payroll component if the payroll component has values in both the payroll period specific data (this endpoint) and in the non-payroll period specific configuration of the employment (it is possible to configure values for payroll components that span multiple payroll periods and even parts thereof).

                                      * When set to `false`, the value of the payroll component will overwrite the value specified in the non-payroll period specific data with the given value in the payroll period specific date.

                                      * When set to `true`, the value of the payroll period specific data will be added to the value of the non-payroll period specific data. Note that a value can be a negative number. For instance, a payroll period specific value of 20 and a non-payroll period specific value of -8 will effectively result in 12 for salary calculation.

                                      This boolean can only be set to `true` in components for which `payrollComponent.canBesupplemented = true`.
                                    example: false
                                    nullable: false
                                    readOnly: false
                                    type: boolean
                                  payrollComponent:
                                    description: |
                                      A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment for the given payroll period.  <br/>  Please note: Business rules may differ per component! Understanding these business rules and corresponding validations requires functional knowledge of Loket.
                                    format: metadata
                                    properties:
                                      canBeSupplemented:
                                        description: |
                                          Indicates whether the atribute for this payroll component can have the value `supplement`. Refer to the description of the attribute field for an explanation.
                                        example: false
                                        nullable: false
                                        readOnly: true
                                        type: boolean
                                      category:
                                        description: |
                                          The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.
                                        format: metadata
                                        nullable: false
                                        properties:
                                          key:
                                            example: 1
                                            format: int32
                                            nullable: false
                                            readOnly: true
                                            type: integer
                                          value:
                                            example: Uren
                                            nullable: false
                                            readOnly: true
                                            type: string
                                        readOnly: true
                                        type: object
                                      deductionOrPayment:
                                        description: |
                                          Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
                                        format: metadata
                                        nullable: true
                                        properties:
                                          key:
                                            example: 2
                                            format: int32
                                            nullable: false
                                            readOnly: true
                                            type: integer
                                          value:
                                            example: Betaling
                                            nullable: false
                                            readOnly: true
                                            type: string
                                        readOnly: true
                                        type: object
                                      description:
                                        description: |
                                          The description of the payroll component
                                        example: Uren gewerkt
                                        maxLength: 14
                                        nullable: false
                                        readOnly: true
                                        type: string
                                      key:
                                        description: |
                                          The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know it by heart.
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                    type: object
                                  value:
                                    description: |
                                      Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules).
                                    example: 144
                                    nullable: false
                                    readOnly: false
                                    type: number
                                type: object
                              type: array
                            payrollPeriod:
                              format: metadata
                              nullable: false
                              properties:
                                periodEndDate:
                                  description: |
                                    The last day of the period to which the payroll period data applies
                                  example: 2018-01-31
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                periodNumber:
                                  description: |
                                    The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period in which the payroll data is to be processed.
                                  example: 1
                                  format: int32
                                  maximum: 53
                                  minimum: 1
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                periodStartDate:
                                  description: |
                                    The first day of the period to which the payroll period data applies
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                year:
                                  description: |
                                    The year of the payroll period in which the payroll data is to be processed
                                  example: 2017
                                  format: int32
                                  maximum: 9999
                                  minimum: 2000
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              readOnly: true
                              type: object
                            payslipText:
                              description: |
                                A custom text to be displayed on the payslip.
                              example: Additional payslip for bonus
                              maxLength: 25
                              minLength: 1
                              nullable: true
                              readOnly: false
                              type: string
                            payslipType:
                              description: |
                                The type of payslip (as defined by the Dutch tax authorities)
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: Bijzonder tarief strook
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            shift:
                              description: |
                                The shift determines the full-time hours and bonus percentage.
                              format: metadata
                              nullable: false
                              properties:
                                bonusPercentage:
                                  description: |
                                    The bonus percentage used in wage calculations for the hours made in this shift.
                                  example: 12
                                  nullable: false
                                  readOnly: true
                                  type: number
                                fullTimeHoursPerWeek:
                                  description: |
                                    The full time hours for an employment that is linked to this shift.
                                  example: 40
                                  nullable: false
                                  readOnly: true
                                  type: number
                                shiftNumber:
                                  description: |
                                    The number for the shift. Loket.nl supports a maximum of 5 shifts per payroll administration.
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payroll period data
      tags:
        - Payroll period data
    patch:
      description: |
        **This endpoint is the REST alternative to the ImporteerGegevens (Variabele Gegevens) SOAP webservice functionality**  <br/> <br/> __Activity name :__ PatchPayrollPeriodDataByEmploymentId <br/> <br/>         This endpoint is typically used by applications that are considered to be leading in regard to the values for the payroll components they manage. For most (external) applications this will the most viable endpoint to achieve that functionality. Loket considers these parties as not interested in the current state of the payroll period data in the Loket.nl database. This endpoint is provided to make these scenarios easier to implement since no GET call is required to determine whether a POST or PUT call is to be performed to either insert or update payroll period data.
        Based on the current state of the database Loket.nl will either insert a new record or update the existing record with the supplied data.
        * A new record is created when the combination of `payrollPeriod`, `shift`, `payslipType`, `distributionUnit`, `costCenter` and `costUnit` is valid and _does not_ exist for the employment. Next to that, the objects consisting of `payrollComponent`, `value` and `attribute` are inserted into the database. <br />
        * An update is performed when the combination of `payrollPeriod`, `shift`, `payslipType`, `distributionUnit`, `costCenter` and `costUnit` _does_ exist for the employment. In that case the specified objects consisting of `payrollComponent`, `value` and `attribute` are inserted into the database, overwriting existing values. Existing records with a `payrollComponent.key` that is not supplied in the request are not modified. <br/> <br/> __Metadata :__ <br/> Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PATCH URL <br/> Possible values for fields of the type 'metadata' that are PERIOD-specific can be acquired (GET) by adding `/metadata/year/{year}/period/{periodNumber}` to the PATCH URL     <br/> <br/>   __Default values :__ <br/> Default values may be acquired by adding `/defaults` (GET) to the PATCH url . It is very much (!!!) recommended to acquire the defaults-objects first and use that information when inserting data for this employment. I.e. use the default values for costCenter, shift etcetera and the complement the object with the payroll components you want to provide. <br/> <br/>      __Extra background reading :__ <br/> It may be useful to read more about payroll period data (variabele gegevens, mutaties) on the Loket.nl [helpdesk portal](https://helpdesk.loket.nl/hc/nl/articles/115003667669-Variabele-mutaties-Individuele-vastlegging). Please note that this information is in Dutch and access is required. <br/>
      operationId: PatchPayrollPeriodDataByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                costCenter:
                  description: |
                    The cost center on which the payroll period data for this record will be booked for the ledger.
                  format: metadata
                  nullable: true
                  properties:
                    code:
                      example: SAL073
                      nullable: false
                      readOnly: true
                      type: string
                    description:
                      example: Sales Den Bosch
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
                costUnit:
                  description: |
                    The cost unit on which the data for this record will be booked for the ledger
                  format: metadata
                  nullable: true
                  properties:
                    code:
                      example: "01"
                      nullable: false
                      readOnly: true
                      type: string
                    description:
                      example: Cars
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
                distributionUnit:
                  description: |
                    Distribution unit (verdelingseenheid), used in several reports and the "basic wage journal" functionality. Commonly used as a cost center.
                  format: metadata
                  nullable: false
                  properties:
                    code:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    description:
                      example: Sales
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      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
                  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
                payrollComponents:
                  items:
                    properties:
                      isSupplement:
                        description: |
                          This boolean determines what the salary calculation will do with the value of the payroll component if the payroll component has values in both the payroll period specific data (this endpoint) and in the non-payroll period specific configuration of the employment (it is possible to configure values for payroll components that span multiple payroll periods and even parts thereof).

                          * When set to `false`, the value of the payroll component will overwrite the value specified in the non-payroll period specific data with the given value in the payroll period specific date.

                          * When set to `true`, the value of the payroll period specific data will be added to the value of the non-payroll period specific data. Note that a value can be a negative number. For instance, a payroll period specific value of 20 and a non-payroll period specific value of -8 will effectively result in 12 for salary calculation.

                          This boolean can only be set to `true` in components for which `payrollComponent.canBesupplemented = true`.
                        example: false
                        nullable: false
                        readOnly: false
                        type: boolean
                      payrollComponent:
                        description: |
                          A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment for the given payroll period.  <br/>  Please note: Business rules may differ per component! Understanding these business rules and corresponding validations requires functional knowledge of Loket.
                        format: metadata
                        properties:
                          canBeSupplemented:
                            description: |
                              Indicates whether the atribute for this payroll component can have the value `supplement`. Refer to the description of the attribute field for an explanation.
                            example: false
                            nullable: false
                            readOnly: true
                            type: boolean
                          category:
                            description: |
                              The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Uren
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          deductionOrPayment:
                            description: |
                              Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Betaling
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          description:
                            description: |
                              The description of the payroll component
                            example: Uren gewerkt
                            maxLength: 14
                            nullable: false
                            readOnly: true
                            type: string
                          key:
                            description: |
                              The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know it by heart.
                            example: 1
                            format: int32
                            nullable: false
                            readOnly: false
                            type: integer
                        type: object
                      value:
                        description: |
                          Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules).                                                   

                          Please note: a `null` value will be seen as empty, any period-specific record for the corresponding component will be deleted for the payroll period it applies to. This is something different than setting it to the value of 0 (!).


                           Please also note the following (!!!) if you do not have a value for the component in this period please do not include this payrollComponent at all in your request. If you do so, this might result in unexpected results.
                        example: 144
                        nullable: true
                        readOnly: false
                        type: number
                    type: object
                  type: array
                payrollPeriod:
                  format: metadata
                  nullable: false
                  properties:
                    periodEndDate:
                      description: |
                        The last day of the period to which the payroll period data applies
                      example: 2018-01-31
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    periodNumber:
                      description: |
                        The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period in which the payroll data is to be processed.
                      example: 1
                      format: int32
                      maximum: 53
                      minimum: 1
                      nullable: false
                      readOnly: false
                      type: integer
                    periodStartDate:
                      description: |
                        The first day of the period to which the payroll period data applies
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    year:
                      description: |
                        The year of the payroll period in which the payroll data is to be processed
                      example: 2017
                      format: int32
                      maximum: 9999
                      minimum: 2000
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
                payslipText:
                  description: |
                    A custom text to be displayed on the payslip.
                  example: Additional payslip for bonus
                  maxLength: 25
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                payslipType:
                  description: |
                    The type of payslip (as defined by the Dutch tax authorities)
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Bijzonder tarief strook
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                shift:
                  description: |
                    The shift determines the full-time hours and bonus percentage.
                  format: metadata
                  nullable: false
                  properties:
                    bonusPercentage:
                      description: |
                        The bonus percentage used in wage calculations for the hours made in this shift.
                      example: 12
                      nullable: false
                      readOnly: true
                      type: number
                    fullTimeHoursPerWeek:
                      description: |
                        The full time hours for an employment that is linked to this shift.
                      example: 40
                      nullable: false
                      readOnly: true
                      type: number
                    shiftNumber:
                      description: |
                        The number for the shift. Loket.nl supports a maximum of 5 shifts per payroll administration.
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
        description: Payroll period data to add to or update for the employment.
        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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Insert or update payroll period data
      tags:
        - Payroll period data
    post:
      description: |
        __Activity name :__ PostPayrollPeriodDataByEmploymentId <br/> <br/>         Create a payroll period date record for an employment <br/> <br/> __Metadata :__ <br/> Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL <br/> Possible values for fields of the type 'metadata' that are PERIOD-specific can be acquired (GET) by adding `/metadata/year/{year}/period/{periodNumber}` to the POST URL <br/> __Default values :__ <br/> * Default values may be acquired by adding `/defaults` (GET) to the POST url
      operationId: PostPayrollPeriodDataByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                costCenter:
                  description: |
                    The cost center on which the payroll period data for this record will be booked for the ledger.

                    `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metadata
                  nullable: true
                  properties:
                    code:
                      example: SAL073
                      nullable: false
                      readOnly: true
                      type: string
                    description:
                      example: Sales Den Bosch
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
                costUnit:
                  description: |
                    The cost unit on which the data for this record will be booked for the ledger

                    `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metadata
                  nullable: true
                  properties:
                    code:
                      example: "01"
                      nullable: false
                      readOnly: true
                      type: string
                    description:
                      example: Cars
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
                distributionUnit:
                  description: |
                    Distribution unit, used in several reports and the "basic wage journal" functionality. Commonly used as a cost center.

                    `distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    code:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    description:
                      example: Sales
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      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
                  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
                payrollComponents:
                  items:
                    properties:
                      isSupplement:
                        description: |
                          This boolean determines what the salary calculation will do with the value of the payroll component if the payroll component has values in both the payroll period specific data (this endpoint) and in the non-payroll period specific configuration of the employment (it is possible to configure values for payroll components that span multiple payroll periods and even parts thereof).

                          * When set to `false`, the value of the payroll component will overwrite the value specified in the non-payroll period specific data with the given value in the payroll period specific date.

                          * When set to `true`, the value of the payroll period specific data will be added to the value of the non-payroll period specific data. Note that a value can be a negative number. For instance, a payroll period specific value of 20 and a non-payroll period specific value of -8 will effectively result in 12 for salary calculation.

                          This boolean can only be set to `true` in components for which `payrollComponent.canBesupplemented = true`.
                        example: false
                        nullable: false
                        readOnly: false
                        type: boolean
                      payrollComponent:
                        description: |
                          A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment for the given payroll period.  <br/>  Please note; Business rules may differ per component! Understanding these business rules and corresponding validations requires functional knowledge of Loket.

                          `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                        format: metadata
                        properties:
                          canBeSupplemented:
                            description: |
                              Indicates whether the atribute for this payroll component can have the value `supplement`. Refer to the description of the attribute field for an explanation.
                            example: false
                            nullable: false
                            readOnly: true
                            type: boolean
                          category:
                            description: |
                              The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Uren
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          deductionOrPayment:
                            description: |
                              Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Betaling
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          key:
                            description: |
                              The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know it by heart.
                            example: 1
                            format: int32
                            nullable: false
                            readOnly: false
                            type: integer
                          value:
                            description: |
                              The description of the payroll component
                            example: Uren gewerkt
                            maxLength: 14
                            nullable: false
                            readOnly: true
                            type: string
                        type: object
                      value:
                        description: |
                          Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules).
                        example: 144
                        nullable: false
                        readOnly: false
                        type: number
                    type: object
                  type: array
                payrollPeriod:
                  format: metadata
                  nullable: false
                  properties:
                    periodEndDate:
                      description: |
                        The last day of the period to which the payroll period data applies
                      example: 2018-01-31
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    periodNumber:
                      description: |
                        The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period in which the payroll data is to be processed.
                      example: 1
                      format: int32
                      maximum: 53
                      minimum: 1
                      nullable: false
                      readOnly: false
                      type: integer
                    periodStartDate:
                      description: |
                        The first day of the period to which the payroll period data applies
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    year:
                      description: |
                        The year of the payroll period in which the payroll data is to be processed
                      example: 2017
                      format: int32
                      maximum: 9999
                      minimum: 2000
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
                payslipText:
                  description: |
                    A custom text to be displayed on the payslip.
                  example: Additional payslip for bonus
                  maxLength: 25
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                payslipType:
                  description: |
                    The type of payslip (as defined by the Dutch tax authorities)
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Bijzonder tarief strook
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                shift:
                  description: |
                    The shift determines the full-time hours and bonus percentage.

                    `shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    bonusPercentage:
                      description: |
                        The bonus percentage used in wage calculations for the hours made in this shift.
                      example: 12
                      nullable: false
                      readOnly: true
                      type: number
                    fullTimeHoursPerWeek:
                      description: |
                        The full time hours for an employment that is linked to this shift.
                      example: 40
                      nullable: false
                      readOnly: true
                      type: number
                    shiftNumber:
                      description: |
                        The number for the shift. Loket.nl supports a maximum of 5 shifts per payroll administration.
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
        description: Payroll variables to add to the employment.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          costCenter:
                            description: |
                              The cost center on which the payroll period data for this record will be booked for the ledger.
                            format: metadata
                            nullable: true
                            properties:
                              code:
                                example: SAL073
                                nullable: false
                                readOnly: true
                                type: string
                              description:
                                example: Sales Den Bosch
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          costUnit:
                            description: |
                              The cost unit on which the data for this record will be booked for the ledger
                            format: metadata
                            nullable: true
                            properties:
                              code:
                                example: "01"
                                nullable: false
                                readOnly: true
                                type: string
                              description:
                                example: Cars
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          distributionUnit:
                            description: |
                              Distribution unit, used in several reports and the "basic wage journal" functionality. Commonly used as a cost center.
                            format: metadata
                            nullable: false
                            properties:
                              code:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              description:
                                example: Sales
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                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
                            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
                          payrollComponents:
                            items:
                              properties:
                                isSupplement:
                                  description: |
                                    This boolean determines what the salary calculation will do with the value of the payroll component if the payroll component has values in both the payroll period specific data (this endpoint) and in the non-payroll period specific configuration of the employment (it is possible to configure values for payroll components that span multiple payroll periods and even parts thereof).

                                    * When set to `false`, the value of the payroll component will overwrite the value specified in the non-payroll period specific data with the given value in the payroll period specific date.

                                    * When set to `true`, the value of the payroll period specific data will be added to the value of the non-payroll period specific data. Note that a value can be a negative number. For instance, a payroll period specific value of 20 and a non-payroll period specific value of -8 will effectively result in 12 for salary calculation.

                                    This boolean can only be set to `true` in components for which `payrollComponent.canBesupplemented = true`.
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                payrollComponent:
                                  description: |
                                    A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment for the given payroll period.  <br/>  Please note: Business rules may differ per component! Understanding these business rules and corresponding validations requires functional knowledge of Loket.
                                  format: metadata
                                  properties:
                                    canBeSupplemented:
                                      description: |
                                        Indicates whether the atribute for this payroll component can have the value `supplement`. Refer to the description of the attribute field for an explanation.
                                      example: false
                                      nullable: false
                                      readOnly: true
                                      type: boolean
                                    category:
                                      description: |
                                        The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        value:
                                          example: Uren
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    deductionOrPayment:
                                      description: |
                                        Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
                                      format: metadata
                                      nullable: true
                                      properties:
                                        key:
                                          example: 2
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        value:
                                          example: Betaling
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    description:
                                      description: |
                                        The description of the payroll component
                                      example: Uren gewerkt
                                      maxLength: 14
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      description: |
                                        The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know it by heart.
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                value:
                                  description: |
                                    Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules).
                                  example: 144
                                  nullable: false
                                  readOnly: false
                                  type: number
                              type: object
                            type: array
                          payrollPeriod:
                            format: metadata
                            nullable: false
                            properties:
                              periodEndDate:
                                description: |
                                  The last day of the period to which the payroll period data applies
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: |
                                  The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period in which the payroll data is to be processed.
                                example: 1
                                format: int32
                                maximum: 53
                                minimum: 1
                                nullable: false
                                readOnly: true
                                type: integer
                              periodStartDate:
                                description: |
                                  The first day of the period to which the payroll period data applies
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: |
                                  The year of the payroll period in which the payroll data is to be processed
                                example: 2017
                                format: int32
                                maximum: 9999
                                minimum: 2000
                                nullable: false
                                readOnly: true
                                type: integer
                            readOnly: true
                            type: object
                          payslipText:
                            description: |
                              A custom text to be displayed on the payslip.
                            example: Additional payslip for bonus
                            maxLength: 25
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          payslipType:
                            description: |
                              The type of payslip (as defined by the Dutch tax authorities)
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Bijzonder tarief strook
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          shift:
                            description: |
                              The shift determines the full-time hours and bonus percentage.
                            format: metadata
                            nullable: false
                            properties:
                              bonusPercentage:
                                description: |
                                  The bonus percentage used in wage calculations for the hours made in this shift.
                                example: 12
                                nullable: false
                                readOnly: true
                                type: number
                              fullTimeHoursPerWeek:
                                description: |
                                  The full time hours for an employment that is linked to this shift.
                                example: 40
                                nullable: false
                                readOnly: true
                                type: number
                              shiftNumber:
                                description: |
                                  The number for the shift. Loket.nl supports a maximum of 5 shifts per payroll administration.
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payroll period data record for an employment
      tags:
        - Payroll period data
  "/providers/employers/employees/employments/{employmentId}/payrollperiodresults/year/{year}":
    get:
      description: |
        __Activity name :__ GetPayrollPeriodResultsByEmploymentIdAndYear

        Download the payroll results (conform overzicht strook) of an employment per payroll period for the provided year.

        **Please note the following:**  There is a major functional difference between acquiring the payslips per payroll run or acquiring payroll results per payroll period(in this case a year). In Loket, for each (approved) run there will be payroll results for that run. Each employment with any results in that payroll run will have (one or more) payslips, these are the payroll results/ payslips for that run. Often these results relate to the payroll period for which that payroll run is performed, but the results may apply to other payroll periods. __For example:__ the payroll run for March may contain results that apply to the months January and/or February. (this may occur within a specific year)

        * Requesting payslips/results per RUN will provide you all payroll results from that specific payrollrun regardless of the period it applies to.
        * Requesting PERIOD results will provide you all (approved) payroll results for that period regardless of the payroll run it comes from.

        De facto the payslips/results per RUN are your actual payslips (loonstrook). The results per period are more useful as an overview per period (overzichtstrook).

        One more remark: the response of this endpoint is dependent on the role of the user. If the user has role 'werknemer' than the results shown are only based on those approved payroll runs where the ESS-date is on or before today. For other users the results will contain data from all approved payroll runs regardless of ESS-date.
      operationId: GetPayrollPeriodResultsByEmploymentIdAndYear
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 employment
          in: path
          name: employmentId
          required: true
          schema:
            format: uuid
            type: string
        - description: The payroll year
          in: path
          name: year
          required: true
          schema:
            example: 2018
            format: int32
            maxLength: 4
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          employmentId:
                            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
                          payrollPeriods:
                            items:
                              properties:
                                payrollPeriod:
                                  format: metadata
                                  properties:
                                    periodEndDate:
                                      description: The last day of the period for which the tax return message was created
                                      example: 2018-01-31
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    periodNumber:
                                      description: The period number of the payroll period the record relates to
                                      example: 1
                                      format: int32
                                      nullable: true
                                      readOnly: false
                                      type: integer
                                    periodStartDate:
                                      description: The first day of the period for which the tax return message was created
                                      example: 2018-01-01
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    testYear:
                                      description: |-
                                        Indicates whether the payroll periode is part of a test year.

                                        In Loket it is possible to run a year of a payrolladministration as a so-called test year.  This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. 
                                        Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
                                      example: false
                                      nullable: false
                                      readOnly: true
                                      type: boolean
                                    year:
                                      description: The year of the payroll period the record relates to
                                      example: 2017
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                payslipTypes:
                                  items:
                                    properties:
                                      payrollComponentResults:
                                        items:
                                          properties:
                                            payrollComponent:
                                              description: |
                                                A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                                                `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                              format: metadata
                                              properties:
                                                category:
                                                  description: |
                                                    The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.    
                                                  format: metadata
                                                  nullable: false
                                                  properties:
                                                    key:
                                                      example: 1
                                                      format: int32
                                                      nullable: false
                                                      readOnly: true
                                                      type: integer
                                                    value:
                                                      example: Uren
                                                      nullable: false
                                                      readOnly: true
                                                      type: string
                                                  readOnly: true
                                                  type: object
                                                column:
                                                  description: |
                                                    The wage sheet column (kolom) of the payroll component. Kolommen are related to its specific lines on the payslip and/or wage sheet.  Also this does bear some similiarties to wage sheets columns (loonstaatkolommen) used by the Belastingdienst, however the division of columns as used by Loket is not identical to that.
                                                  format: metadata
                                                  nullable: false
                                                  properties:
                                                    key:
                                                      example: 6
                                                      format: int32
                                                      nullable: false
                                                      readOnly: true
                                                      type: integer
                                                    value:
                                                      example: Sociaalplichtig loon
                                                      nullable: false
                                                      readOnly: true
                                                      type: string
                                                  readOnly: true
                                                  type: object
                                                costsEmployer:
                                                  description: |
                                                    Indicates whether the components are costs for the employer (+) or negative costs (-, i.e. benefit) for the employer. The value could also be NULL meaning that the component is not related to actual expenses.
                                                  format: metadata
                                                  nullable: true
                                                  properties:
                                                    key:
                                                      example: 1
                                                      format: int32
                                                      nullable: false
                                                      readOnly: true
                                                      type: integer
                                                    value:
                                                      example: +
                                                      nullable: false
                                                      readOnly: true
                                                      type: string
                                                  readOnly: true
                                                  type: object
                                                countAsNormHours:
                                                  description: |
                                                    Indicates whether its value is counted as norm hours (bij bepalen normuren)
                                                  example: true
                                                  nullable: false
                                                  readOnly: true
                                                  type: boolean
                                                hoursIndication:
                                                  description: |
                                                    Only applicable for component in category 6 (eenheden)
                                                  nullable: true
                                                  readOnly: true
                                                  type: boolean
                                                key:
                                                  description: |
                                                    The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart.
                                                  example: 1
                                                  format: int32
                                                  nullable: false
                                                  readOnly: false
                                                  type: integer
                                                value:
                                                  description: |
                                                    The description of the payroll component
                                                  example: Uren gewerkt
                                                  maxLength: 14
                                                  nullable: false
                                                  readOnly: true
                                                  type: string
                                              type: object
                                            value:
                                              description: Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this.
                                              example: 40
                                              nullable: false
                                              readOnly: true
                                              type: number
                                            valueSpecialTariff:
                                              description: Value/ amount (speciaal tarief voor belasting) for the payrollcomponent. Both a 'normal' and 'special tariff' type payslip may a value for this. Also, both valueNormal and valueSpecialTariff may have a value at the same time.
                                              example: 144
                                              nullable: false
                                              readOnly: true
                                              type: number
                                          type: object
                                        type: array
                                      payslipType:
                                        description: |
                                          The type of payslip on which underlying payroll run results will be booked. This is either normaal or bijzonder tarief.
                                        format: metadata
                                        nullable: false
                                        properties:
                                          key:
                                            example: 1
                                            format: int32
                                            nullable: false
                                            readOnly: true
                                            type: integer
                                          value:
                                            example: Normaal strook
                                            nullable: false
                                            readOnly: true
                                            type: string
                                        readOnly: true
                                        type: object
                                    type: object
                                  minimum: 0
                                  type: array
                              type: object
                            type: array
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payroll period results of an employment for a year
      tags:
        - Payslip
  "/providers/employers/employees/employments/{employmentId}/payslips":
    get:
      description: |
        __Activity name :__ GetPayslipsByEmploymentId

        Get a list of payslips for the specified employment, including the GUID of the corresponding payroll run.

        The function of this endpoint is dependent on the role of the user;
        * For users with the role of 'werknemer';  The endpoint only returns results for payrollruns that have the status 'approved' AND for which results of the payroll are available for ESS (based on the ESS-date of the payrollrun) .
        * For users with any other role (in most cases); the endpoin returns results for approved payrollruns irregardless of the ESS date.
      operationId: GetPayslipsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            approvalTime:
                              description: The time at which the payslip was approved.
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            numberOfPayslips:
                              description: The number of different types of payslips for the given payroll period.
                              example: 1
                              format: int32
                              maximum: 3
                              minimum: 1
                              nullable: false
                              readOnly: true
                              type: integer
                            payrollPeriod:
                              format: metadata
                              properties:
                                periodEndDate:
                                  description: The last day of the period for which the tax return message was created
                                  example: 2018-01-31
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                periodNumber:
                                  description: The period number of the payroll period the record relates to
                                  example: 1
                                  format: int32
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                periodStartDate:
                                  description: The first day of the period for which the tax return message was created
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                testYear:
                                  description: |-
                                    Indicates whether the payroll periode is part of a test year.

                                    In Loket it is possible to run a year of a payrolladministration as a so-called test year.  This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. 
                                    Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
                                  example: false
                                  nullable: false
                                  readOnly: true
                                  type: boolean
                                year:
                                  description: The year of the payroll period the record relates to
                                  example: 2017
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            payrollrunId:
                              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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payslips for an employment
      tags:
        - Payslip
  "/providers/employers/employees/employments/{employmentId}/payslips/summary/{payrollPeriodId}":
    get:
      description: |
        __Activity name :__ GetPayrollPeriodSummaryByEmploymentIdAndPayrollPeriodId

        Download a cummulative payslip for a single payroll period in a single PDF.

        e.g. If the employment has to payslips for a single period this endpoint will return one (summary)payslip that is the cummaltion of both the payslips.

        __Metadata :__ Possible options for `payrollPeriodId` can be acquired (GET) the following URL /providers/employers/employees/employments/{employmentId}/payslips/summary/metadata.
        Please note that the returned payroll periods are dependend on the year filter setting for the employer. The options are, return payroll periodes for:
         
        * current payroll year * current and previous payroll year * all payroll years
      operationId: GetPayrollPeriodSummaryByEmploymentIdAndPayrollPeriodId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 employment
          in: path
          name: employmentId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of an payroll period
          in: path
          name: payrollPeriodId
          required: true
          schema:
            format: uuid
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download a cummulative payslip for a single payroll period
      tags:
        - Payslip
  "/providers/employers/employees/employments/{employmentId}/payslips/{payrollrunId}":
    get:
      description: |
        __Activity name :__ GetPayslipsByEmploymentIdAndPayrollRunId

        Download the payslips or its underlying payroll results of an employment for the specified payrollrun

        **Please note: this endpoint has two types of output:**
        * the payslip(s) as a single PDF-file
        * the underlying payroll result data for the payslip(s) in JSON-format  

        This may be specified by providing the desired format in the `Accept` header of your request.
      operationId: GetPayslipsByEmploymentIdAndPayrollRunId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 employment
          in: path
          name: employmentId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of the payroll run
          in: path
          name: payrollrunId
          required: true
          schema:
            format: uuid
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          employmentId:
                            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
                          payrollPeriods:
                            items:
                              properties:
                                payrollPeriod:
                                  format: metadata
                                  properties:
                                    periodEndDate:
                                      description: The last day of the period for which the tax return message was created
                                      example: 2018-01-31
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    periodNumber:
                                      description: The period number of the payroll period the record relates to
                                      example: 1
                                      format: int32
                                      nullable: true
                                      readOnly: false
                                      type: integer
                                    periodStartDate:
                                      description: The first day of the period for which the tax return message was created
                                      example: 2018-01-01
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    testYear:
                                      description: |-
                                        Indicates whether the payroll periode is part of a test year.

                                        In Loket it is possible to run a year of a payrolladministration as a so-called test year.  This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. 
                                        Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
                                      example: false
                                      nullable: false
                                      readOnly: true
                                      type: boolean
                                    year:
                                      description: The year of the payroll period the record relates to
                                      example: 2017
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                payslipTypes:
                                  items:
                                    properties:
                                      payrollComponentResults:
                                        items:
                                          properties:
                                            payrollComponent:
                                              description: |
                                                A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                                                `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                              format: metadata
                                              properties:
                                                category:
                                                  description: |
                                                    The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.    
                                                  format: metadata
                                                  nullable: false
                                                  properties:
                                                    key:
                                                      example: 1
                                                      format: int32
                                                      nullable: false
                                                      readOnly: true
                                                      type: integer
                                                    value:
                                                      example: Uren
                                                      nullable: false
                                                      readOnly: true
                                                      type: string
                                                  readOnly: true
                                                  type: object
                                                column:
                                                  description: |
                                                    The wage sheet column (kolom) of the payroll component. Kolommen are related to its specific lines on the payslip and/or wage sheet.  Also this does bear some similiarties to wage sheets columns (loonstaatkolommen) used by the Belastingdienst, however the division of columns as used by Loket is not identical to that.
                                                  format: metadata
                                                  nullable: false
                                                  properties:
                                                    key:
                                                      example: 6
                                                      format: int32
                                                      nullable: false
                                                      readOnly: true
                                                      type: integer
                                                    value:
                                                      example: Sociaalplichtig loon
                                                      nullable: false
                                                      readOnly: true
                                                      type: string
                                                  readOnly: true
                                                  type: object
                                                costsEmployer:
                                                  description: |
                                                    Indicates whether the components are costs for the employer (+) or negative costs (-, i.e. benefit) for the employer. The value could also be NULL meaning that the component is not related to actual expenses.
                                                  format: metadata
                                                  nullable: true
                                                  properties:
                                                    key:
                                                      example: 1
                                                      format: int32
                                                      nullable: false
                                                      readOnly: true
                                                      type: integer
                                                    value:
                                                      example: +
                                                      nullable: false
                                                      readOnly: true
                                                      type: string
                                                  readOnly: true
                                                  type: object
                                                key:
                                                  description: |
                                                    The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart.
                                                  example: 1
                                                  format: int32
                                                  nullable: false
                                                  readOnly: false
                                                  type: integer
                                                value:
                                                  description: |
                                                    The description of the payroll component
                                                  example: Uren gewerkt
                                                  maxLength: 14
                                                  nullable: false
                                                  readOnly: true
                                                  type: string
                                              type: object
                                            value:
                                              description: Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this.
                                              example: 40
                                              nullable: false
                                              readOnly: true
                                              type: number
                                            valueSpecialTariff:
                                              description: Value/ amount (speciaal tarief voor belasting) for the payrollcomponent. Both a 'normal' and 'special tariff' type payslip may a value for this. Also, both valueNormal and valueSpecialTariff may have a value at the same time.
                                              example: 144
                                              nullable: false
                                              readOnly: true
                                              type: number
                                          type: object
                                        type: array
                                      payslipType:
                                        description: |
                                          The type of payslip on which underlying payroll run results will be booked. This is either normaal or bijzonder tarief.
                                        format: metadata
                                        nullable: false
                                        properties:
                                          key:
                                            example: 1
                                            format: int32
                                            nullable: false
                                            readOnly: true
                                            type: integer
                                          value:
                                            example: Normaal strook
                                            nullable: false
                                            readOnly: true
                                            type: string
                                        readOnly: true
                                        type: object
                                    type: object
                                  type: array
                              type: object
                            type: array
                        type: object
                    type: object
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download payslips of an employment for a payrollrun
      tags:
        - Payslip
  "/providers/employers/employees/employments/{employmentId}/payslips/{year}":
    get:
      description: |
        __Activity name :__ GetPayslipsByEmploymentIdAndYear

        Download the payslips for a payroll year in a single PDF

        __Metadata :__ Possible options for `year` can be acquired (GET) the following URL /providers/employers/employees/employments/{employmentId}/payslips/metadata.
      operationId: GetPayslipsByEmploymentIdAndYear
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 employment
          in: path
          name: employmentId
          required: true
          schema:
            format: uuid
            type: string
        - description: The payroll year
          in: path
          name: year
          required: true
          schema:
            example: 2018
            format: int32
            maxLength: 4
            type: integer
      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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download payslips for an employment and year
      tags:
        - Payslip
  "/providers/employers/employees/employments/{employmentId}/pensionbenefits":
    get:
      description: |
        __Activity name :__ GetPensionBenefitsByEmploymentId

        Get a list of the pension benefits of the employment.

        __Note:__ Loket.nl has different ways to register pension benefit. 
      operationId: GetPensionBenefitsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              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
                            payout:
                              description: The ammount of (gross) pension received
                              example: 2569
                              format: double
                              maximum: 100000
                              minimum: 0
                              nullable: false
                              pattern: ^(\d{1,8})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            startDate:
                              description: |-
                                The date on which this pension benefit starts

                                A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                              example: 2018-01-01
                              format: date
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 pension benefit
      tags:
        - Pension benefit
    post:
      description: |
        __Activity name :__ PostPensionBenefitByEmploymentId

        __Metadata :__ No metadata

        __Defaults :__ No default values
      operationId: PostPensionBenefitByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  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
                payout:
                  description: The ammount of (gross) pension received
                  example: 2569
                  format: double
                  maximum: 100000
                  minimum: 0
                  nullable: false
                  pattern: ^(\d{1,8})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                startDate:
                  description: |-
                    The date on which this pension benefit starts

                    A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
        description: Add a pension benefit
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            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
                          payout:
                            description: The ammount of (gross) pension received
                            example: 2569
                            format: double
                            maximum: 100000
                            minimum: 0
                            nullable: false
                            pattern: ^(\d{1,8})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          startDate:
                            description: |-
                              The date on which this pension benefit starts

                              A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 pension benefit for an employment
      tags:
        - Pension benefit
  "/providers/employers/employees/employments/{employmentId}/protectedearnings":
    get:
      description: |
        __Activity name :__ GetProtectedEarningsByEmploymentId

        Get a list of protected earnings records
      operationId: GetProtectedEarningsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            endDate:
                              description: |
                                The end date of the record
                              example: 2018-10-23
                              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: |
                                Start date of this record
                                A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.

                                __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for protected earning (based on the start- and enddate, not based on the payroll period of the payroll run).
                              example: 2018-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            threshold:
                              description: The total amount of net wage that is protected.
                              example: 50
                              format: double
                              maximum: 99999999.99
                              minimum: 0
                              nullable: false
                              pattern: ^(\d{1,8})(\.\d{1,2})?$
                              readOnly: false
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 protected earnings records
      tags:
        - Protected earnings
    post:
      description: |
        __Activity name :__ PostProtectedEarningsByEmploymentId

        Create a new protected earnings record for an employment.

        __Metadata :__ There is no metadata for this resource

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostProtectedEarningsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
          applicationjson;version=2018-01-01:
            schema:
              properties:
                endDate:
                  description: |
                    The end date of the record
                  example: 2018-10-23
                  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: |
                    Start date of this record
                    A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.

                    __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for protected earning (based on the start- and enddate, not based on the payroll period of the payroll run).
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                threshold:
                  description: The total amount of net wage that is protected.
                  example: 50
                  format: double
                  maximum: 99999999.99
                  minimum: 0
                  nullable: false
                  pattern: ^(\d{1,8})(\.\d{1,2})?$
                  readOnly: false
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          endDate:
                            description: |
                              The end date of the record
                            example: 2018-10-23
                            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: |
                              Start date of this record
                              A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.

                              __NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for protected earning (based on the start- and enddate, not based on the payroll period of the payroll run).
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          threshold:
                            description: The total amount of net wage that is protected.
                            example: 50
                            format: double
                            maximum: 99999999.99
                            minimum: 0
                            nullable: false
                            pattern: ^(\d{1,8})(\.\d{1,2})?$
                            readOnly: false
                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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 new protected earnings record
      tags:
        - Protected earnings
  "/providers/employers/employees/employments/{employmentId}/reinstate":
    patch:
      description: |
        __Activity name :__  PatchReinstateByEmploymentId

        reinstate for an employment. <br/> Effectively,  termination is reversed by using this endpoint and therefore the employment will be considered active again. 

        Maak een uitdienst melding ongedaan.<br/> Effectief gezien, 'datum uit dienst' gegevens worden teruggedraaid waardoor het dienstverband weer als actief zal worden beschouwd in Loket <br/>
      operationId: PatchReinstateByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
              type: object
        description: This endpoint does not require a request body. However, the `Accept` header does need to be set to ensure the correct resource version is used.
      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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Undo termination for an employment.
      tags:
        - Employment
  "/providers/employers/employees/employments/{employmentId}/socialsecuritybenefits":
    get:
      description: |
        __Activity name:__ GetSocialSecurityBenefitsByEmploymentId
            

        Get the list of social security benefits records for an employment
      operationId: GetSocialSecurityBenefitByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - nullable: false
                              properties:
                                endDate:
                                  description: The end date of the entity. The date is up to and including.
                                  example: 2018-10-23
                                  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 start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year.

                                    A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: false
                                  type: string
                                supplementation:
                                  nullable: false
                                  properties:
                                    percentage:
                                      description: |
                                        If supplementation is applied then the supplementation percentage (up to) is registered here.
                                      example: 35
                                      format: double
                                      maximum: 100
                                      minimum: 0
                                      nullable: false
                                      pattern: ^(\d{1,3})(\.\d{1,2})?$
                                      readOnly: false
                                      type: number
                                    type:
                                      description: |
                                        Indicates whether and how supplementation should be applied. This is used when the employer supplements the pay out percentage.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          example: 3
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                        value:
                                          example: Suppleren (bruto)
                                          maxLength: 50
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      type: object
                                  type: object
                              type: object
                            - properties:
                                benefit:
                                  nullable: false
                                  properties:
                                    percentage:
                                      description: |
                                        Pay out percentage of the benefit (deviating from the administration). This value determines the percentage to be applied, the only exception is when type of benefit is set to AOW where the percentage cannot be in altered (=0).
                                      example: 35
                                      format: double
                                      maximum: 100
                                      minimum: 0
                                      nullable: false
                                      pattern: ^(\d{1,3})(\.\d{1,2})?$
                                      readOnly: false
                                      type: number
                                    type:
                                      description: |
                                        The type of social security benefit that is applicable. Per type of benefit a so-called closed-chain input validation is used. This field cannot be changed after the initial post.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        value:
                                          example: ZW eigen risico
                                          maxLength: 50
                                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 social security benefits records for an employment
      tags:
        - Social security benefits
    post:
      description: |
        __Activity name:__ PostSocialSecurityBenefitByEmploymentId
            

        Create a social security benefits record for an employment
        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostSocialSecurityBenefitByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                - nullable: false
                  properties:
                    endDate:
                      description: The end date of the entity. The date is up to and including.
                      example: 2018-10-23
                      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 start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year.

                        A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                      example: 2018-01-01
                      format: date
                      nullable: false
                      readOnly: false
                      type: string
                    supplementation:
                      nullable: false
                      properties:
                        percentage:
                          description: |
                            If supplementation is applied then the supplementation percentage (up to) is registered here.
                          example: 35
                          format: double
                          maximum: 100
                          minimum: 0
                          nullable: false
                          pattern: ^(\d{1,3})(\.\d{1,2})?$
                          readOnly: false
                          type: number
                        type:
                          description: |
                            Indicates whether and how supplementation should be applied. This is used when the employer supplements the pay out percentage.
                          format: metadata
                          nullable: false
                          properties:
                            key:
                              example: 3
                              format: int32
                              nullable: false
                              readOnly: false
                              type: integer
                            value:
                              example: Suppleren (bruto)
                              maxLength: 50
                              nullable: false
                              readOnly: true
                              type: string
                          type: object
                      type: object
                  type: object
                - properties:
                    benefit:
                      nullable: false
                      properties:
                        percentage:
                          description: |
                            Pay out percentage of the benefit (deviating from the administration). This value determines the percentage to be applied, the only exception is when type of benefit is set to AOW where the percentage cannot be in altered (=0).
                          example: 35
                          format: double
                          maximum: 100
                          minimum: 0
                          nullable: false
                          pattern: ^(\d{1,3})(\.\d{1,2})?$
                          readOnly: false
                          type: number
                        type:
                          description: |
                            The type of social security benefit that is applicable. Per type of benefit a so-called closed-chain input validation is used. This field cannot be changed after the initial post.
                          format: metadata
                          nullable: false
                          properties:
                            key:
                              example: 1
                              format: int32
                              nullable: false
                              readOnly: true
                              type: integer
                            value:
                              example: ZW eigen risico
                              maxLength: 50
                              nullable: false
                              readOnly: true
                              type: string
                          type: object
                      type: object
        description: Social security record to add to the employment.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        allOf:
                          - nullable: false
                            properties:
                              endDate:
                                description: The end date of the entity. The date is up to and including.
                                example: 2018-10-23
                                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 start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year.

                                  A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: false
                                type: string
                              supplementation:
                                nullable: false
                                properties:
                                  percentage:
                                    description: |
                                      If supplementation is applied then the supplementation percentage (up to) is registered here.
                                    example: 35
                                    format: double
                                    maximum: 100
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,3})(\.\d{1,2})?$
                                    readOnly: false
                                    type: number
                                  type:
                                    description: |
                                      Indicates whether and how supplementation should be applied. This is used when the employer supplements the pay out percentage.
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        example: 3
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        example: Suppleren (bruto)
                                        maxLength: 50
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                type: object
                            type: object
                          - properties:
                              benefit:
                                nullable: false
                                properties:
                                  percentage:
                                    description: |
                                      Pay out percentage of the benefit (deviating from the administration). This value determines the percentage to be applied, the only exception is when type of benefit is set to AOW where the percentage cannot be in altered (=0).
                                    example: 35
                                    format: double
                                    maximum: 100
                                    minimum: 0
                                    nullable: false
                                    pattern: ^(\d{1,3})(\.\d{1,2})?$
                                    readOnly: false
                                    type: number
                                  type:
                                    description: |
                                      The type of social security benefit that is applicable. Per type of benefit a so-called closed-chain input validation is used. This field cannot be changed after the initial post.
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: true
                                        type: integer
                                      value:
                                        example: ZW eigen risico
                                        maxLength: 50
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                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: 2018-12-31
                            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 <field>
                              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.
                                See [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 social security benefits record for an employment
      tags:
        - Social security benefits
  "/providers/employers/employees/employments/{employmentId}/socialsecurityconfigurations":
    get:
      description: |
        __Activity name:__ GetSocialSecurityConfigurationsByEmploymentId
            

        Get the list of social security configuration records for an employment
      operationId: GetSocialSecurityConfigurationByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: false
                          properties:
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              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
                            isInsuredForOccupationalDisabilityInsuranceAct:
                              description: Will contributions for the Occupational Disability Insurance Act (WAO) be payed for this employment
                              example: true
                              nullable: false
                              readOnly: false
                              type: boolean
                            isInsuredForSicknessBenefitsAct:
                              description: Will contributions for the  Sickness Benefits Act (ZW) be payed for this employment
                              example: true
                              nullable: false
                              readOnly: false
                              type: boolean
                            isInsuredForUnemploymentInsuranceAct:
                              description: Will contributions for the  Unemployment Insurance Act (WW) be payed for this employment
                              example: true
                              nullable: false
                              readOnly: false
                              type: boolean
                            startDate:
                              description: |-
                                The start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year.

                                A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                              example: 2018-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 social security records for an employment
      tags:
        - Social security
    post:
      description: |
        __Activity name:__ PostSocialSecurityConfigurationByEmploymentId
            

        Create a social security configuration record for an employment

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostSocialSecurityConfigurationByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: false
              properties:
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  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
                isInsuredForOccupationalDisabilityInsuranceAct:
                  description: Will contributions for the Occupational Disability Insurance Act (WAO) be payed for this employment
                  example: true
                  nullable: false
                  readOnly: false
                  type: boolean
                isInsuredForSicknessBenefitsAct:
                  description: Will contributions for the  Sickness Benefits Act (ZW) be payed for this employment
                  example: true
                  nullable: false
                  readOnly: false
                  type: boolean
                isInsuredForUnemploymentInsuranceAct:
                  description: Will contributions for the  Unemployment Insurance Act (WW) be payed for this employment
                  example: true
                  nullable: false
                  readOnly: false
                  type: boolean
                startDate:
                  description: |-
                    The start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year.

                    A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
              type: object
        description: Social security record to add to the employment.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            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
                          isInsuredForOccupationalDisabilityInsuranceAct:
                            description: Will contributions for the Occupational Disability Insurance Act (WAO) be payed for this employment
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          isInsuredForSicknessBenefitsAct:
                            description: Will contributions for the  Sickness Benefits Act (ZW) be payed for this employment
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          isInsuredForUnemploymentInsuranceAct:
                            description: Will contributions for the  Unemployment Insurance Act (WW) be payed for this employment
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          startDate:
                            description: |-
                              The start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 social security record for an employment
      tags:
        - Social security
  "/providers/employers/employees/employments/{employmentId}/terminate":
    patch:
      description: |
        __Activity name :__  PatchTerminateByEmploymentId

        Terminate an employment. Effectively, the `endDate` of the employment will be set to the given date.<br/> Please note that setting the `endDate` for an employment affects multiple resources in Loket (e.g. wage, workingHours and absence). Note that the termination date is to be filled with the last day of employment.<br/>

        If the termination needs to be reversed use the `../employments/{employmentId}/reinstate` endpoint. <br/> If the termination needs to be changed, use this endpoint to revise the termination data<br/>

        The metadata for endOfEmploymentReason and endOfEmploymentReasonTaxAuthorities are included in the 'regular' metadata-endpoint of the Employment resource. 
      operationId: PatchTerminateByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                createMdvEntry:
                  description: |
                    Indicates whether an MDV-entry should automatically be generated (not sent) by Loket (Melding Dienstverband). This should typically only be used for Colland-related employments and if the module MDV is active for an employer, which means in most cases this indicator should be set to `false`.

                    Next to that, a message is ONLY generated when the employment is actually terminated by performing this action (=the employment did not already have an endDate before calling this endpoint).
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                endDate:
                  description: |
                    The date on which the employment ends (=last day of the employment).
                  example: 2018-10-23
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                endOfEmploymentDueToIllness:
                  description: |
                    Indicates whether the reason for the termination of an employment is due to long-term illness. Mandatory if endDate is filled, else leave empty.
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                endOfEmploymentReason:
                  description: |
                    The reason for the end of the employment. Mandatory if endDate is filled, else leave empty.
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  readOnly: false
                  type: object
          application/json;version=2019-12-16:
            schema:
              properties:
                createMdvEntry:
                  description: |
                    Indicates whether an MDV-entry should automatically be generated (not sent) by Loket (Melding Dienstverband). This should typically only be used for Colland-related employments and if the module MDV is active for an employer, which means in most cases this indicator should be set to `false`.

                    Next to that, a message is ONLY generated when the employment is actually terminated by performing this action (=the employment did not already have an endDate before calling this endpoint).
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                endDate:
                  description: |
                    The date on which the employment ends (=last day of the employment).
                  example: 2018-10-23
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                endOfEmploymentDueToIllness:
                  description: |
                    Indicates whether the reason for the termination of an employment is due to long-term illness. Mandatory if endDate is filled, else leave empty.
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                endOfEmploymentReason:
                  description: |-
                    The reason for the end of the employment.

                    __Note:__ as of 2020-01-01 `endOfEmploymentReasonTaxAuthorities` replaces this field as the main reason for the end of the employment. We say 'main reason' as in certain cases this field still has a purpose. 

                    Please set this field to 8 (Other) unless one of the following integrations is used for this employment
                      * UPA-pensioenaangifte
                      * Cordares
                      * APG-pensioenaangifte
                      * Achmea
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      description: The key for the reason for the end of the employment.
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: The description of the reason for the end of the employment.
                      example: VUT
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
                endOfEmploymentReasonTaxAuthorities:
                  description: |
                    The reason for the end of the employment as specified by the Dutch Tax authorties.

                    __Note:__ This field replaces `endOfEmploymentReason` as of 2020-01-01. `endOfEmploymentReason` will remain as a field in the resource as several integration require this field still.
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      description: The key for the reason for the end of the employment.
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: The description of the reason for the end of the employment.
                      example: Opzegging door de werkgever binnen de proeftijd.
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
        description: The request body contains an object containing fields related to termination of an employment.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        type: object
                    type: object
            application/json;version=2019-12-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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Terminate an employment.
      tags:
        - Employment
  "/providers/employers/employees/employments/{employmentId}/transitioncompensation":
    post:
      description: |
        __Activity name :__ PostTransitionCompensationEmploymentByEmploymentId

        Create an additional employment for an already existing and terminated employment with the sole purpose to pay out a transition compensation.
      operationId: PostTransitionCompensationEmploymentByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
              type: object
        description: This endpoint does not require a request body. However, the `Accept` header does need to be set to ensure the correct resource version is used.
      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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - 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
                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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 transition compensation employment for existing employment
      tags:
        - Create employment
  "/providers/employers/employees/employments/{employmentId}/transitioncompensation/calculate":
    post:
      description: |
        This is a controller endpoint to perform a calculation. No actual data will be stored as a result of these actions.

        __Activity name :__ PostCalculateTransitionCompensationByEmploymentId

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults` to the POST URL. This will only include the default values for the input parameter fields (the actual calculation of the transition compensation is not part of that)

        A calculation help for determining the transition compensation amount. (rekenhulp transitievergoeding)
      operationId: PostCalculateTransitionCompensationByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                baseCalculationsBonusPercentage:
                  description: |
                    The bonus percentage used in wage calculations based on an accumulation of given base calculations (grondslagen)
                  example: 12
                  format: double
                  maximum: 99.99
                  minimum: 0
                  nullable: false
                  readOnly: false
                  type: number
                endDate:
                  description: The date on which the employment ends.
                  example: 2018-10-23
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                grossMonthlySupplement:
                  description: |
                    An additional monthly amount, if applicable.
                  example: 212
                  format: double
                  maximum: 999999.99
                  minimum: 0
                  nullable: false
                  readOnly: false
                  type: number
                grossMonthlyWage:
                  description: |
                    Gross wage/ basic wage for the employment per month.
                  example: 2300
                  format: double
                  maximum: 999999.99
                  minimum: 0
                  nullable: false
                  readOnly: false
                  type: number
                shiftBonusPercentage:
                  description: |
                    The bonus percentage used in wage calculations based on given shift.
                  example: 12
                  format: double
                  maximum: 99.99
                  minimum: 0
                  nullable: false
                  readOnly: false
                  type: number
                startDate:
                  description: The date on which this employment starts.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
              readOnly: false
              type: object
        description: Transition compensation input parameters
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          employmentDurationInDecimalYears:
                            description: |
                              Calculated employment duration in years, as a decimal number.
                            example: 3.5
                            format: double
                            maximum: 999999.99
                            minimum: 0
                            nullable: false
                            readOnly: true
                            type: number
                          monthlyWage:
                            description: |
                              Calculated wage for the employment per month.
                            example: 2300
                            format: double
                            maximum: 999999.99
                            minimum: 0
                            nullable: false
                            readOnly: true
                            type: number
                          transitionCompensationAmount:
                            description: |
                              Calculated total amount for the transition compensation.
                            example: 8050
                            format: double
                            maximum: 999999.99
                            minimum: 0
                            nullable: false
                            readOnly: true
                            type: number
                        readOnly: true
                        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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Calculate transition compensation
      tags:
        - Transition compensation
  "/providers/employers/employees/employments/{employmentId}/transitioncompensation/calculate/defaults":
    get:
      description: |
        __Activity name :__ GetCalculateTransitionCompensationDefaultsByEmploymentId


         Get the default values of the input parameters for the POST action.
      operationId: GetCalculateTransitionCompensationDefaultsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          baseCalculationsBonusPercentage:
                            description: |
                              The bonus percentage used in wage calculations based on an accumulation of given base calculations (grondslagen)
                            example: 12
                            format: double
                            maximum: 99.99
                            minimum: 0
                            nullable: false
                            readOnly: false
                            type: number
                          endDate:
                            description: The date on which the employment ends.
                            example: 2018-10-23
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          grossMonthlySupplement:
                            description: |
                              An additional monthly amount, if applicable.
                            example: 212
                            format: double
                            maximum: 999999.99
                            minimum: 0
                            nullable: false
                            readOnly: false
                            type: number
                          grossMonthlyWage:
                            description: |
                              Gross wage/ basic wage for the employment per month.
                            example: 2300
                            format: double
                            maximum: 999999.99
                            minimum: 0
                            nullable: false
                            readOnly: false
                            type: number
                          shiftBonusPercentage:
                            description: |
                              The bonus percentage used in wage calculations based on given shift.
                            example: 12
                            format: double
                            maximum: 99.99
                            minimum: 0
                            nullable: false
                            readOnly: false
                            type: number
                          startDate:
                            description: The date on which this employment starts.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                        readOnly: false
                        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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 default input parameters transition compensation
      tags:
        - Transition compensation
  "/providers/employers/employees/employments/{employmentId}/wachtgeld":
    get:
      description: |
        __Activity name :__ GetWachtgeldByEmploymentId

        Get a list of wachtgeld of the employment.

        __Note:__ Wachtgeld, or redundancy pay, is an additional benefit that you receive on top of your unemployment benefit.
      operationId: GetWachtgeldByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: true
                          properties:
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              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
                            startDate:
                              description: |-
                                The date on which this wachtgeld record starts.

                                A (linked chain)[./#section/Data/Date-chains] per wachtgeld is maintained within this resource. So only one wachtgeld record can be active at the same time. 
                              example: 2021-06-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            value:
                              description: |
                                The value for the wachtgeld.
                              example: 50.87
                              maximum: 99999.99
                              minimum: 0.01
                              nullable: true
                              pattern: ^(\d{1,5})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            valueAdditionalIncomeCivilService:
                              description: |
                                The value of additional income civil service (Neveninkomsten ambtelijk).
                              example: 50.87
                              maximum: 99999.99
                              minimum: 0.01
                              nullable: true
                              pattern: ^(\d{1,5})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            valueAdditionalIncomeNonCivilService:
                              description: |
                                The value of additional income non civil service (Neveninkomsten niet ambtelijk).
                              example: 50.87
                              maximum: 99999.99
                              minimum: 0.01
                              nullable: true
                              pattern: ^(\d{1,5})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 wachtgeld
      tags:
        - Wachtgeld
    post:
      description: |
        __Activity name :__ PostWachtgeldByEmploymentId __Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL. __Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostWachtgeldByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  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
                startDate:
                  description: |-
                    The date on which this wachtgeld record starts.

                    A (linked chain)[./#section/Data/Date-chains] per wachtgeld is maintained within this resource. So only one wachtgeld record can be active at the same time. 
                  example: 2021-06-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                value:
                  description: |
                    The value for the wachtgeld.
                  example: 50.87
                  maximum: 99999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,5})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                valueAdditionalIncomeCivilService:
                  description: |
                    The value of additional income civil service (Neveninkomsten ambtelijk).
                  example: 50.87
                  maximum: 99999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,5})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                valueAdditionalIncomeNonCivilService:
                  description: |
                    The value of additional income non civil service (Neveninkomsten niet ambtelijk).
                  example: 50.87
                  maximum: 99999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,5})(\.\d{1,2})?$
                  readOnly: false
                  type: number
              type: object
        description: Add a wachtgeld
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            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
                          startDate:
                            description: |-
                              The date on which this wachtgeld record starts.

                              A (linked chain)[./#section/Data/Date-chains] per wachtgeld is maintained within this resource. So only one wachtgeld record can be active at the same time. 
                            example: 2021-06-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          value:
                            description: |
                              The value for the wachtgeld.
                            example: 50.87
                            maximum: 99999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,5})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          valueAdditionalIncomeCivilService:
                            description: |
                              The value of additional income civil service (Neveninkomsten ambtelijk).
                            example: 50.87
                            maximum: 99999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,5})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          valueAdditionalIncomeNonCivilService:
                            description: |
                              The value of additional income non civil service (Neveninkomsten niet ambtelijk).
                            example: 50.87
                            maximum: 99999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,5})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 wachtgeld for an employment
      tags:
        - Wachtgeld
  "/providers/employers/employees/employments/{employmentId}/wageprojection":
    post:
      description: |-
        __Activity name :__ PostWageProjectionByEmploymentId

        This endpoint can only be used for employments that are already known in the loket.nl system.

        __Metadata :__  No metadata endpoint available for this controller endpoint.

        __Defaults :__ No defaults endpoint available for this controller endpoint.
      operationId: PostWageProjectionByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: false
              properties:
                calculateUsingNextYearsValues:
                  default: false
                  description: If set to true the wage projection will use the (government) salary values of the next payroll year to calculate the wages. This gives some insight in what the employments wages will do next year based on the government's tax plans."
                  example: true
                  nullable: true
                  readOnly: false
                  type: boolean
                deviations:
                  description: This endpoint can only be used for employments that are already known in the loket.nl system. If however you want to perform a calculation with different parameters then that are known in the loket system they can be set here
                  nullable: true
                  properties:
                    hoursPerWeek:
                      description: The hours per week used in wage calculations.
                      example: 37.5
                      maximum: 99.99
                      minimum: 1
                      nullable: true
                      readOnly: false
                      type: number
                    percentageChange:
                      description: The percentage change used in wage calculations.
                      example: 25
                      maximum: 99.99
                      minimum: 0.01
                      nullable: true
                      readOnly: false
                      type: number
                    startDate:
                      description: The start date for the information in the record.
                      example: 1995-05-21
                      format: date
                      nullable: false
                      readOnly: false
                      type: string
                  readOnly: false
                  type: object
              type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          employmentId:
                            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
                          payrollPeriods:
                            items:
                              properties:
                                payrollPeriod:
                                  format: metadata
                                  properties:
                                    periodEndDate:
                                      description: The last day of the period for which the tax return message was created
                                      example: 2018-01-31
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    periodNumber:
                                      description: The period number of the payroll period the record relates to
                                      example: 1
                                      format: int32
                                      nullable: true
                                      readOnly: false
                                      type: integer
                                    periodStartDate:
                                      description: The first day of the period for which the tax return message was created
                                      example: 2018-01-01
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    testYear:
                                      description: |-
                                        Indicates whether the payroll periode is part of a test year.

                                        In Loket it is possible to run a year of a payrolladministration as a so-called test year.  This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. 
                                        Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
                                      example: false
                                      nullable: false
                                      readOnly: true
                                      type: boolean
                                    year:
                                      description: The year of the payroll period the record relates to
                                      example: 2017
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                payslipTypes:
                                  items:
                                    properties:
                                      payrollComponentResults:
                                        items:
                                          properties:
                                            payrollComponent:
                                              description: |
                                                A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                                                `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                              format: metadata
                                              properties:
                                                category:
                                                  description: |
                                                    The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.    
                                                  format: metadata
                                                  nullable: false
                                                  properties:
                                                    key:
                                                      example: 1
                                                      format: int32
                                                      nullable: false
                                                      readOnly: true
                                                      type: integer
                                                    value:
                                                      example: Uren
                                                      nullable: false
                                                      readOnly: true
                                                      type: string
                                                  readOnly: true
                                                  type: object
                                                column:
                                                  description: |
                                                    The wage sheet column (kolom) of the payroll component. Kolommen are related to its specific lines on the payslip and/or wage sheet.  Also this does bear some similiarties to wage sheets columns (loonstaatkolommen) used by the Belastingdienst, however the division of columns as used by Loket is not identical to that.
                                                  format: metadata
                                                  nullable: false
                                                  properties:
                                                    key:
                                                      example: 6
                                                      format: int32
                                                      nullable: false
                                                      readOnly: true
                                                      type: integer
                                                    value:
                                                      example: Sociaalplichtig loon
                                                      nullable: false
                                                      readOnly: true
                                                      type: string
                                                  readOnly: true
                                                  type: object
                                                costsEmployer:
                                                  description: |
                                                    Indicates whether the components are costs for the employer (+) or negative costs (-, i.e. benefit) for the employer. The value could also be NULL meaning that the component is not related to actual expenses.
                                                  format: metadata
                                                  nullable: true
                                                  properties:
                                                    key:
                                                      example: 1
                                                      format: int32
                                                      nullable: false
                                                      readOnly: true
                                                      type: integer
                                                    value:
                                                      example: +
                                                      nullable: false
                                                      readOnly: true
                                                      type: string
                                                  readOnly: true
                                                  type: object
                                                key:
                                                  description: |
                                                    The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart.
                                                  example: 1
                                                  format: int32
                                                  nullable: false
                                                  readOnly: false
                                                  type: integer
                                                value:
                                                  description: |
                                                    The description of the payroll component
                                                  example: Uren gewerkt
                                                  maxLength: 14
                                                  nullable: false
                                                  readOnly: true
                                                  type: string
                                              type: object
                                            value:
                                              description: Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this.
                                              example: 40
                                              nullable: false
                                              readOnly: true
                                              type: number
                                            valueSpecialTariff:
                                              description: Value/ amount (speciaal tarief voor belasting) for the payrollcomponent. Both a 'normal' and 'special tariff' type payslip may a value for this. Also, both valueNormal and valueSpecialTariff may have a value at the same time.
                                              example: 144
                                              nullable: false
                                              readOnly: true
                                              type: number
                                          type: object
                                        type: array
                                      payslipType:
                                        description: |
                                          The type of payslip on which underlying payroll run results will be booked. This is either normaal or bijzonder tarief.
                                        format: metadata
                                        nullable: false
                                        properties:
                                          key:
                                            example: 1
                                            format: int32
                                            nullable: false
                                            readOnly: true
                                            type: integer
                                          value:
                                            example: Normaal strook
                                            nullable: false
                                            readOnly: true
                                            type: string
                                        readOnly: true
                                        type: object
                                    type: object
                                  type: array
                              type: object
                            type: array
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Perform a wage projection
      tags:
        - Wage projection
  "/providers/employers/employees/employments/{employmentId}/wageprojection/basedOnDefaultClaConfiguration":
    post:
      description: |-
        __Activity name :__ PostWageprojectionBasedOnDefaultClaConfigurationByEmploymentId

        This endpoint can be used to calculate a wage projection based on a default collective labor agreement (CLA) configuration.  The input fields allow for certain customizations.

        __Metadata :__  No metadata endpoint available for this controller endpoint.

        __Defaults :__ No defaults endpoint available for this controller endpoint.
      operationId: PostWageprojectionBasedOnDefaultClaConfigurationByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: false
              properties:
                additionalPayrollPeriod:
                  nullable: true
                  properties:
                    percentage:
                      description: The percentage for the additional payroll period wage the employment receives (13e maand / extra periode loon / winstuitkering)
                      example: 8
                      maximum: 999.999999
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: number
                    resultPayrollComponent:
                      description: |-
                        A payroll component. These components are the core of the wage calculation software.

                        `payrollComponents` is a metadata field within the payroll administration, loonmodel and cao context. Possible values can be managed by the user.
                      format: metadata
                      properties:
                        key:
                          description: |
                            The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart.
                          example: 83
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                      type: object
                  readOnly: false
                  type: object
                applyPayrollTaxDeduction:
                  description: Indicates whether payroll tax deduction is to be applied (loonheffingskorting)
                  example: false
                  nullable: true
                  readOnly: false
                  type: boolean
                calculateUsingNextYearsValues:
                  default: false
                  description: If set to true the wage projection will use the (government) salary values of the next payroll year to calculate the wages. This gives some insight in what the employments wages will do next year based on the government's tax plans."
                  example: true
                  nullable: true
                  readOnly: false
                  type: boolean
                companyCar:
                  nullable: true
                  properties:
                    fiscalAddition:
                      description: |
                        The fiscal addition to the wage for the given `fiscalAdditionPeriod` for the lease/company car
                      example: 345.87
                      maximum: 999999.99
                      minimum: 0.01
                      nullable: false
                      readOnly: false
                      type: number
                    fiscalAdditionPeriod:
                      description: Periodicity of the `fiscalAddition`
                      enum:
                        - Year
                        - payrollPeriod
                      nullable: false
                      readOnly: false
                      type: string
                  type: object
                dateOfBirth:
                  description: |
                    The date of birth
                  example: 1995-05-21
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                deductions:
                  nullable: true
                  properties:
                    gross:
                      description: |
                        The gross deduction from the wage
                      example: 50.87
                      maximum: 999999.99
                      minimum: 0.01
                      nullable: true
                      readOnly: false
                      type: number
                    net:
                      description: |
                        The net deduction from the wage
                      example: 50.87
                      maximum: 999999.99
                      minimum: 0.01
                      nullable: true
                      readOnly: false
                      type: number
                  type: object
                deviations:
                  description: |-
                    Deviations allow the user to calculate the difference between the current wage and the wage after certain deviations.
                    If no deviations are required set the object to NULL
                  nullable: true
                  properties:
                    grossWagePercentageChange:
                      description: The percentage change used in wage calculations.
                      example: 25
                      maximum: 99.99
                      minimum: 0.01
                      nullable: true
                      readOnly: false
                      type: number
                    hoursPerWeek:
                      description: The hours per week used in wage calculations.
                      example: 37.5
                      maximum: 99.99
                      minimum: 1
                      nullable: true
                      readOnly: false
                      type: number
                  readOnly: false
                  type: object
                grossWage:
                  description: The grosswage per payroll period
                  example: 3500
                  format: double
                  maximum: 999999.99
                  minimum: 0.01
                  nullable: false
                  readOnly: false
                  type: number
                holidayAllowance:
                  nullable: true
                  properties:
                    percentage:
                      description: The percentage for the holiday bonus (vakantiegeld)
                      example: 8
                      maximum: 999.999999
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: number
                    resultPayrollComponent:
                      format: metadata
                      properties:
                        key:
                          description: |
                            The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart.
                          example: 82
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                      type: object
                  readOnly: false
                  type: object
                hoursPerWeek:
                  description: |-
                    The hours per week te be used in the wage calculation. 

                    Please note that currently this endpoint will always calculate as if the hours provided are full time hours.
                  example: 24.5
                  format: double
                  maximum: 99.99
                  minimum: 0.01
                  nullable: false
                  readOnly: false
                  type: number
                payments:
                  nullable: true
                  properties:
                    gross:
                      description: |
                        The gross payment added to the wage
                      example: 50.87
                      maximum: 999999.99
                      minimum: 0.01
                      nullable: true
                      readOnly: false
                      type: number
                    net:
                      description: |
                        The net payment added to the wage
                      example: 50.87
                      maximum: 999999.99
                      minimum: 0.01
                      nullable: true
                      readOnly: false
                      type: number
                  type: object
              type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          employmentId:
                            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
                          payrollPeriods:
                            items:
                              properties:
                                payrollPeriod:
                                  format: metadata
                                  properties:
                                    periodEndDate:
                                      description: The last day of the period for which the tax return message was created
                                      example: 2018-01-31
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    periodNumber:
                                      description: The period number of the payroll period the record relates to
                                      example: 1
                                      format: int32
                                      nullable: true
                                      readOnly: false
                                      type: integer
                                    periodStartDate:
                                      description: The first day of the period for which the tax return message was created
                                      example: 2018-01-01
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    testYear:
                                      description: |-
                                        Indicates whether the payroll periode is part of a test year.

                                        In Loket it is possible to run a year of a payrolladministration as a so-called test year.  This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. 
                                        Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
                                      example: false
                                      nullable: false
                                      readOnly: true
                                      type: boolean
                                    year:
                                      description: The year of the payroll period the record relates to
                                      example: 2017
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                payslipTypes:
                                  items:
                                    properties:
                                      payrollComponentResults:
                                        items:
                                          properties:
                                            payrollComponent:
                                              description: |
                                                A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                                                `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                              format: metadata
                                              properties:
                                                category:
                                                  description: |
                                                    The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.    
                                                  format: metadata
                                                  nullable: false
                                                  properties:
                                                    key:
                                                      example: 1
                                                      format: int32
                                                      nullable: false
                                                      readOnly: true
                                                      type: integer
                                                    value:
                                                      example: Uren
                                                      nullable: false
                                                      readOnly: true
                                                      type: string
                                                  readOnly: true
                                                  type: object
                                                column:
                                                  description: |
                                                    The wage sheet column (kolom) of the payroll component. Kolommen are related to its specific lines on the payslip and/or wage sheet.  Also this does bear some similiarties to wage sheets columns (loonstaatkolommen) used by the Belastingdienst, however the division of columns as used by Loket is not identical to that.
                                                  format: metadata
                                                  nullable: false
                                                  properties:
                                                    key:
                                                      example: 6
                                                      format: int32
                                                      nullable: false
                                                      readOnly: true
                                                      type: integer
                                                    value:
                                                      example: Sociaalplichtig loon
                                                      nullable: false
                                                      readOnly: true
                                                      type: string
                                                  readOnly: true
                                                  type: object
                                                costsEmployer:
                                                  description: |
                                                    Indicates whether the components are costs for the employer (+) or negative costs (-, i.e. benefit) for the employer. The value could also be NULL meaning that the component is not related to actual expenses.
                                                  format: metadata
                                                  nullable: true
                                                  properties:
                                                    key:
                                                      example: 1
                                                      format: int32
                                                      nullable: false
                                                      readOnly: true
                                                      type: integer
                                                    value:
                                                      example: +
                                                      nullable: false
                                                      readOnly: true
                                                      type: string
                                                  readOnly: true
                                                  type: object
                                                key:
                                                  description: |
                                                    The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart.
                                                  example: 1
                                                  format: int32
                                                  nullable: false
                                                  readOnly: false
                                                  type: integer
                                                value:
                                                  description: |
                                                    The description of the payroll component
                                                  example: Uren gewerkt
                                                  maxLength: 14
                                                  nullable: false
                                                  readOnly: true
                                                  type: string
                                              type: object
                                            value:
                                              description: Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this.
                                              example: 40
                                              nullable: false
                                              readOnly: true
                                              type: number
                                            valueSpecialTariff:
                                              description: Value/ amount (speciaal tarief voor belasting) for the payrollcomponent. Both a 'normal' and 'special tariff' type payslip may a value for this. Also, both valueNormal and valueSpecialTariff may have a value at the same time.
                                              example: 144
                                              nullable: false
                                              readOnly: true
                                              type: number
                                          type: object
                                        type: array
                                      payslipType:
                                        description: |
                                          The type of payslip on which underlying payroll run results will be booked. This is either normaal or bijzonder tarief.
                                        format: metadata
                                        nullable: false
                                        properties:
                                          key:
                                            example: 1
                                            format: int32
                                            nullable: false
                                            readOnly: true
                                            type: integer
                                          value:
                                            example: Normaal strook
                                            nullable: false
                                            readOnly: true
                                            type: string
                                        readOnly: true
                                        type: object
                                    type: object
                                  type: array
                              type: object
                            type: array
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Perform a wage projection based on a default CLA configuration
      tags:
        - Wage projection
  "/providers/employers/employees/employments/{employmentId}/wages":
    get:
      description: |
        __Activity name :__ GetWagesByEmploymentId

        Get the list of wages for the employment
      operationId: GetWagesByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          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.
                              example: true
                              nullable: true
                              readOnly: false
                              type: boolean
                            employerCosts:
                              description: |
                                The cost for the employer for this employee.
                              example: 3500
                              format: double
                              maximum: 99999.99
                              minimum: 0.01
                              nullable: true
                              readOnly: false
                              type: number
                            employerCostsType:
                              description: |
                                Indicates whether the employer costs are hourly costs or periodic costs. 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.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: hourly
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            endDate:
                              description: |
                                The end date for the information in the record.
                              format: date
                              nullable: true
                              readOnly: true
                              type: string
                            grossWage:
                              description: |
                                The gross wage for the employee
                              example: 2300
                              format: double
                              maximum: 999999.99
                              minimum: 0.01
                              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.
                              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
                            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
                            isGrossWageFullTime:
                              description: |
                                Indicates whether the given grossWage is either a full-time wage or a part-time wage. Full-time wage is the default value (isGrossWageFulltime = true) and Loket.nl recommends to use this option. A full-time wage takes into account the part-time percentage of an employment. While a part-time wage does not. E.g. A full-time wage of 2400 euro’s is registered. The employments works 20 out of 40 hours (40 fours is a full-time shift) thus having a 20/40 = 50% part-time percentage. The part-time hours (deviatingHoursPerWeek) are accessible through the endpoint for working hours of an employement. In the wage calculation Loket.nl will divide the grossWage component by 50% resulting in a grossWage of 1200 euro’s. In the case of a part-time wage the part-time percentage will be ignored.
                              example: true
                              nullable: false
                              readOnly: true
                              type: boolean
                            netWage:
                              description: |
                                Net wage for the employment
                              example: 2400
                              format: double
                              maximum: 999999.99
                              minimum: 0.01
                              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.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  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. 

                                `payGrade` is a metadata field within the payroll administration/payScale 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: 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.

                                `payScale` 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: Glastuinbouw maand, Loongebouw A
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            payrollPeriodType:
                              description: |
                                Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4). The value of this field is used to further specify the meaning of grossWageType, netWageType and employerCostsType. When the key fields of these three wage types have a value 1 (meaning periodic wage), the payrollPeriodType field shows the period type (month, 4 weeks or week) applicable to the wages for the employment. E.g. If the value for grossWageType.key = 1 (periodic wage) and the value for payrollPeriodType.key = 1 (meaning Month), then the wage registerd in grossWage is a monthly wage. Note that in cases where the wage type is an hourly wage (grossWageType.key = 2), the payrollPeriodType should be ignored.
                              nullable: false
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: Maand
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            startDate:
                              description: |
                                The start date for the information in the record.

                                A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                                __Note__ It is posible to have no wage record.
                              example: 1995-05-21
                              format: date
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 wages for an employment
      tags:
        - Wage
    post:
      description: |
        __Activity name :__ PostWageByEmploymentId

        Create a new wage record for the given employment

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST Wage URL.

                
        The possible options for `payGrade` are scoped by a `payScale`. To obtain the pay grades for a pay scale a metadata call has to be performed with the following format `../wages/metadata/payscale/{key}`. Where {key} is the key of the `payScale` (obtained via the first metadata call) for which the pay grades are to be returned.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL and performing a GET action.
      operationId: PostWageByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                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.
                  example: true
                  nullable: true
                  readOnly: false
                  type: boolean
                employerCosts:
                  description: |
                    The cost for the employer for this employee.
                  example: 3500
                  format: double
                  maximum: 99999.99
                  minimum: 0.01
                  nullable: true
                  readOnly: false
                  type: number
                employerCostsType:
                  description: |
                    Indicates whether the employer costs are hourly costs or periodic costs. 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.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: hourly
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                endDate:
                  description: |
                    The end date for the information in the record.
                  format: date
                  nullable: true
                  readOnly: true
                  type: string
                grossWage:
                  description: |
                    The gross wage for the employee
                  example: 2300
                  format: double
                  maximum: 999999.99
                  minimum: 0.01
                  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.
                  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
                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
                isGrossWageFullTime:
                  description: |
                    Indicates whether the given grossWage is either a full-time wage or a part-time wage. Full-time wage is the default value (isGrossWageFulltime = true) and Loket.nl recommends to use this option. A full-time wage takes into account the part-time percentage of an employment. While a part-time wage does not. E.g. A full-time wage of 2400 euro’s is registered. The employments works 20 out of 40 hours (40 fours is a full-time shift) thus having a 20/40 = 50% part-time percentage. The part-time hours (deviatingHoursPerWeek) are accessible through the endpoint for working hours of an employement. In the wage calculation Loket.nl will divide the grossWage component by 50% resulting in a grossWage of 1200 euro’s. In the case of a part-time wage the part-time percentage will be ignored.
                  example: true
                  nullable: false
                  readOnly: true
                  type: boolean
                netWage:
                  description: |
                    Net wage for the employment
                  example: 2400
                  format: double
                  maximum: 999999.99
                  minimum: 0.01
                  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.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      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. 

                    `payGrade` is a metadata field within the payroll administration/payScale 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: 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.

                    `payScale` 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: Glastuinbouw maand, Loongebouw A
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                payrollPeriodType:
                  description: |
                    Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4). The value of this field is used to further specify the meaning of grossWageType, netWageType and employerCostsType. When the key fields of these three wage types have a value 1 (meaning periodic wage), the payrollPeriodType field shows the period type (month, 4 weeks or week) applicable to the wages for the employment. E.g. If the value for grossWageType.key = 1 (periodic wage) and the value for payrollPeriodType.key = 1 (meaning Month), then the wage registerd in grossWage is a monthly wage. Note that in cases where the wage type is an hourly wage (grossWageType.key = 2), the payrollPeriodType should be ignored.
                  nullable: false
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    value:
                      example: Maand
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                startDate:
                  description: |
                    The start date for the information in the record.

                    A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                    __Note__ It is posible to have no wage record.
                  example: 1995-05-21
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
        description: Wage to add to the employment.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        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.
                            example: true
                            nullable: true
                            readOnly: false
                            type: boolean
                          employerCosts:
                            description: |
                              The cost for the employer for this employee.
                            example: 3500
                            format: double
                            maximum: 99999.99
                            minimum: 0.01
                            nullable: true
                            readOnly: false
                            type: number
                          employerCostsType:
                            description: |
                              Indicates whether the employer costs are hourly costs or periodic costs. 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.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: hourly
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          endDate:
                            description: |
                              The end date for the information in the record.
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          grossWage:
                            description: |
                              The gross wage for the employee
                            example: 2300
                            format: double
                            maximum: 999999.99
                            minimum: 0.01
                            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.
                            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
                          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
                          isGrossWageFullTime:
                            description: |
                              Indicates whether the given grossWage is either a full-time wage or a part-time wage. Full-time wage is the default value (isGrossWageFulltime = true) and Loket.nl recommends to use this option. A full-time wage takes into account the part-time percentage of an employment. While a part-time wage does not. E.g. A full-time wage of 2400 euro’s is registered. The employments works 20 out of 40 hours (40 fours is a full-time shift) thus having a 20/40 = 50% part-time percentage. The part-time hours (deviatingHoursPerWeek) are accessible through the endpoint for working hours of an employement. In the wage calculation Loket.nl will divide the grossWage component by 50% resulting in a grossWage of 1200 euro’s. In the case of a part-time wage the part-time percentage will be ignored.
                            example: true
                            nullable: false
                            readOnly: true
                            type: boolean
                          netWage:
                            description: |
                              Net wage for the employment
                            example: 2400
                            format: double
                            maximum: 999999.99
                            minimum: 0.01
                            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.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                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. 

                              `payGrade` is a metadata field within the payroll administration/payScale 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: 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.

                              `payScale` 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: Glastuinbouw maand, Loongebouw A
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          payrollPeriodType:
                            description: |
                              Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4). The value of this field is used to further specify the meaning of grossWageType, netWageType and employerCostsType. When the key fields of these three wage types have a value 1 (meaning periodic wage), the payrollPeriodType field shows the period type (month, 4 weeks or week) applicable to the wages for the employment. E.g. If the value for grossWageType.key = 1 (periodic wage) and the value for payrollPeriodType.key = 1 (meaning Month), then the wage registerd in grossWage is a monthly wage. Note that in cases where the wage type is an hourly wage (grossWageType.key = 2), the payrollPeriodType should be ignored.
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Maand
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          startDate:
                            description: |
                              The start date for the information in the record.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                              __Note__ It is posible to have no wage record.
                            example: 1995-05-21
                            format: date
                            nullable: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 wage for an employment
      tags:
        - Wage
  "/providers/employers/employees/employments/{employmentId}/wagesheet/{year}":
    get:
      description: |
        __Activity name :__ GetWageSheetByEmploymentIdAndYear

        Download the wagesheet (loonstaat) for a payroll year

        __Metadata :__ Possible options for `year` can be acquired (GET) the following URL /providers/employers/employees/employments/{employmentId}/wagesheet/metadata.

        Returns the wage sheets for an employment
      operationId: GetWageSheetByEmploymentIdAndYear
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 employment
          in: path
          name: employmentId
          required: true
          schema:
            format: uuid
            type: string
        - description: The payroll year
          in: path
          name: year
          required: true
          schema:
            example: 2018
            format: int32
            maxLength: 4
            type: integer
      responses:
        "200":
          content:
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download wage sheets for an employment
      tags:
        - Payslip
  "/providers/employers/employees/employments/{employmentId}/workinghours":
    get:
      description: |
        __Activity name :__  GetWorkingHoursByEmploymentId  <br/> <br/>  Get the list of working hours for an employment <br/>
      operationId: GetWorkingHoursByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            aggregatedHoursPerWeek:
                              description: |-
                                This read-only field provides the user with a single point of knowledge as to what number of hours per week employment is actually registered in regards to the payrolling process. This number may be respectively based on the workpattern, deviating hours per week or shift hours. If the employment is an 'on call employment' (oproepkracht/invalkracht) the number is either NULL or represents the min-hours if that is applicable.
                                This field is especially useful for third-parties that want to know the number of hours per week (without having to apply specific Loket logic). I.e. this field is not visible in Loket GUI.
                              example: 24
                              format: double
                              maximum: 168
                              minimum: 0.01
                              nullable: true
                              pattern: ^(\d{1,2})(\.\d{1,2})?$
                              readOnly: true
                              type: number
                            averageHoursPerWeek:
                              description: This field can be used to register the average hours per week an employment with varying hours works. For example, 0 hour contracts and min max contracts. The value of this field does NOT directly affect the payrolling proces.
                              example: 32
                              format: double
                              maximum: 168
                              minimum: 0
                              nullable: true
                              pattern: ^(\d{1,3})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            averageParttimeFactor:
                              description: |-
                                This field is used to register the deviating value of the parttimefactor, purely for administrative purposes. The parttimefactor is normally calculated by workinghours dividing by shifthours multplied by 100. 
                                Please note that this field is not used in the actual payroll proces! For the payroll process the number of hours is used.
                              format: double
                              maximum: 999.99
                              minimum: 0.01
                              nullable: true
                              pattern: ^(\d{1,3})(\.\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). Onderliggende elementen geven aan of specifieke waardes berekend moeten worden op basis van het twee wekelijks werkpatroon `workPattern`
                              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: false
                                  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: false
                                  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: false
                                  readOnly: false
                                  type: boolean
                                hoursRegularPeriod:
                                  description: Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods.
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                leaveHours:
                                  description: |
                                    Indicates whether then leave balances (verlof) are to be calculated based on the workpattern.  If set to false and the user is not linked to a leave policy with `applyLeaveSchedule` set to true the following fields are used for the calculation `deviatingHoursPerWeek` if null `shift.fullTimeHoursPerWeek` is used
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                              type: object
                            contractCode:
                              description: |-
                                This field is specialy made for convenience stores. The field is the type of contract.

                                `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)
                                  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: If this field is empty the fulltime hours are based as defined by the shift, this optional field is used to register an overwriting value. The value can be less or more then the fulltime hours a week.
                              example: 32
                              format: double
                              maximum: 99.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: 20
                              format: int32
                              maximum: 23
                              minimum: 1
                              nullable: true
                              readOnly: false
                              type: integer
                            endDate:
                              description: |
                                The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              format: date
                              nullable: true
                              readOnly: true
                              type: string
                            flexibleHoursContract:
                              description: The field indicates the type of flexible contract. If not applicable, please set to NULL.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Minimum uren contract
                                  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
                            regularWorkPattern:
                              description: When the employee works the same amount of hours per day every week, then the workpattern is regular.
                              example: true
                              nullable: false
                              readOnly: false
                              type: boolean
                            shift:
                              description: |
                                The shift determines the full-time hours and bonus percentage.

                                `shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                              format: metaData
                              nullable: false
                              properties:
                                bonusPercentage:
                                  description: |
                                    The bonus percentage used in wage calculations for the hours made in this shift.
                                  example: 12
                                  maximum: 99
                                  minimum: 0.01
                                  nullable: false
                                  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
                                  nullable: false
                                  readOnly: true
                                  type: number
                                shiftNumber:
                                  description: |
                                    The number for the shift.
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            shiftRateSickLeave:
                              description: |
                                The shift determines the full-time hours and bonus percentage.

                                `shiftRateSickLeave` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                              format: metadata
                              properties:
                                bonusPercentage:
                                  description: |
                                    The bonus percentage used in wage calculations for the hours made in this shift.
                                  example: 12
                                  maximum: 99
                                  minimum: 1
                                  nullable: false
                                  readOnly: true
                                  type: number
                                fullTimeHoursPerWeek:
                                  description: |
                                    The full time hours for an employment that is linked to this shift.
                                  example: 40
                                  maximum: 99
                                  minimum: 1
                                  nullable: false
                                  readOnly: true
                                  type: number
                                shiftNumber:
                                  description: |
                                    The key number to identify the shift to be used for calculation of daily rate in case of sick leave (ziekte).
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            startDate:
                              description: |
                                Start date of the record.

                                A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                              example: 2018-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            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. <br /> Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                              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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 working hours for an employment
      tags:
        - Working hours
    post:
      description: |
        __Activity name :__  PostWorkingHoursByEmploymentId <br/> <br/>  Create a new working hours record for an employment<br/>  Please note that so-called chain validation exists for working hours records. In other words, the time periods of records for an employment cannot overlap with each other.<br/> A new or changed startDate affects the endDate of its preceding record.<br/>  When POST-ing a new record, the startDate must be greater then the preceding record's startDate.

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostWorkingHoursByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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:
                aggregatedHoursPerWeek:
                  description: |-
                    This read-only field provides the user with a single point of knowledge as to what number of hours per week employment is actually registered in regards to the payrolling process. This number may be respectively based on the workpattern, deviating hours per week or shift hours. If the employment is an 'on call employment' (oproepkracht/invalkracht) the number is either NULL or represents the min-hours if that is applicable.
                    This field is especially useful for third-parties that want to know the number of hours per week (without having to apply specific Loket logic). I.e. this field is not visible in Loket GUI.
                  example: 24
                  format: double
                  maximum: 168
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,2})(\.\d{1,2})?$
                  readOnly: true
                  type: number
                averageHoursPerWeek:
                  description: This field can be used to register the average hours per week an employment with varying hours works. For example, 0 hour contracts and min max contracts. The value of this field does NOT directly affect the payrolling proces.
                  example: 32
                  format: double
                  maximum: 168
                  minimum: 0
                  nullable: true
                  pattern: ^(\d{1,3})(\.\d{1,2})?$
                  readOnly: false
                  type: number
                averageParttimeFactor:
                  description: |-
                    This field is used to register the deviating value of the parttimefactor, purely for administrative purposes. The parttimefactor is normally calculated by workinghours dividing by shifthours multplied by 100. 
                    Please note that this field is not used in the actual payroll proces! For the payroll process the number of hours is used.
                  format: double
                  maximum: 999.99
                  minimum: 0.01
                  nullable: true
                  pattern: ^(\d{1,3})(\.\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). Onderliggende elementen geven aan of specifieke waardes berekend moeten worden op basis van het twee wekelijks werkpatroon `workPattern`
                  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: false
                      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: false
                      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: false
                      readOnly: false
                      type: boolean
                    hoursRegularPeriod:
                      description: Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods.
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                    leaveHours:
                      description: |
                        Indicates whether then leave balances (verlof) are to be calculated based on the workpattern.  If set to false and the user is not linked to a leave policy with `applyLeaveSchedule` set to true the following fields are used for the calculation `deviatingHoursPerWeek` if null `shift.fullTimeHoursPerWeek` is used
                      example: true
                      nullable: false
                      readOnly: false
                      type: boolean
                  type: object
                contractCode:
                  description: |-
                    This field is specialy made for convenience stores. The field is the type of contract.

                    `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)
                      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: If this field is empty the fulltime hours are based as defined by the shift, this optional field is used to register an overwriting value. The value can be less or more then the fulltime hours a week.
                  example: 32
                  format: double
                  maximum: 99.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: 20
                  format: int32
                  maximum: 23
                  minimum: 1
                  nullable: true
                  readOnly: false
                  type: integer
                endDate:
                  description: |
                    The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: true
                  type: string
                flexibleHoursContract:
                  description: The field indicates the type of flexible contract. If not applicable, please set to NULL.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Minimum uren contract
                      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
                regularWorkPattern:
                  description: When the employee works the same amount of hours per day every week, then the workpattern is regular.
                  example: true
                  nullable: false
                  readOnly: false
                  type: boolean
                shift:
                  description: |
                    The shift determines the full-time hours and bonus percentage.

                    `shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metaData
                  nullable: false
                  properties:
                    bonusPercentage:
                      description: |
                        The bonus percentage used in wage calculations for the hours made in this shift.
                      example: 12
                      maximum: 99
                      minimum: 0.01
                      nullable: false
                      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
                      nullable: false
                      readOnly: true
                      type: number
                    shiftNumber:
                      description: |
                        The number for the shift.
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
                shiftRateSickLeave:
                  description: |
                    The shift determines the full-time hours and bonus percentage.

                    `shiftRateSickLeave` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metadata
                  properties:
                    bonusPercentage:
                      description: |
                        The bonus percentage used in wage calculations for the hours made in this shift.
                      example: 12
                      maximum: 99
                      minimum: 1
                      nullable: false
                      readOnly: true
                      type: number
                    fullTimeHoursPerWeek:
                      description: |
                        The full time hours for an employment that is linked to this shift.
                      example: 40
                      maximum: 99
                      minimum: 1
                      nullable: false
                      readOnly: true
                      type: number
                    shiftNumber:
                      description: |
                        The key number to identify the shift to be used for calculation of daily rate in case of sick leave (ziekte).
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
                startDate:
                  description: |
                    Start date of the record.

                    A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                  example: 2018-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                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. <br /> Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                  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
        description: Working hours to add to the employment.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          aggregatedHoursPerWeek:
                            description: |-
                              This read-only field provides the user with a single point of knowledge as to what number of hours per week employment is actually registered in regards to the payrolling process. This number may be respectively based on the workpattern, deviating hours per week or shift hours. If the employment is an 'on call employment' (oproepkracht/invalkracht) the number is either NULL or represents the min-hours if that is applicable.
                              This field is especially useful for third-parties that want to know the number of hours per week (without having to apply specific Loket logic). I.e. this field is not visible in Loket GUI.
                            example: 24
                            format: double
                            maximum: 168
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,2})(\.\d{1,2})?$
                            readOnly: true
                            type: number
                          averageHoursPerWeek:
                            description: This field can be used to register the average hours per week an employment with varying hours works. For example, 0 hour contracts and min max contracts. The value of this field does NOT directly affect the payrolling proces.
                            example: 32
                            format: double
                            maximum: 168
                            minimum: 0
                            nullable: true
                            pattern: ^(\d{1,3})(\.\d{1,2})?$
                            readOnly: false
                            type: number
                          averageParttimeFactor:
                            description: |-
                              This field is used to register the deviating value of the parttimefactor, purely for administrative purposes. The parttimefactor is normally calculated by workinghours dividing by shifthours multplied by 100. 
                              Please note that this field is not used in the actual payroll proces! For the payroll process the number of hours is used.
                            format: double
                            maximum: 999.99
                            minimum: 0.01
                            nullable: true
                            pattern: ^(\d{1,3})(\.\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). Onderliggende elementen geven aan of specifieke waardes berekend moeten worden op basis van het twee wekelijks werkpatroon `workPattern`
                            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: false
                                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: false
                                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: false
                                readOnly: false
                                type: boolean
                              hoursRegularPeriod:
                                description: Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods.
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              leaveHours:
                                description: |
                                  Indicates whether then leave balances (verlof) are to be calculated based on the workpattern.  If set to false and the user is not linked to a leave policy with `applyLeaveSchedule` set to true the following fields are used for the calculation `deviatingHoursPerWeek` if null `shift.fullTimeHoursPerWeek` is used
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                            type: object
                          contractCode:
                            description: |-
                              This field is specialy made for convenience stores. The field is the type of contract.

                              `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)
                                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: If this field is empty the fulltime hours are based as defined by the shift, this optional field is used to register an overwriting value. The value can be less or more then the fulltime hours a week.
                            example: 32
                            format: double
                            maximum: 99.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: 20
                            format: int32
                            maximum: 23
                            minimum: 1
                            nullable: true
                            readOnly: false
                            type: integer
                          endDate:
                            description: |
                              The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          flexibleHoursContract:
                            description: The field indicates the type of flexible contract. If not applicable, please set to NULL.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Minimum uren contract
                                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
                          regularWorkPattern:
                            description: When the employee works the same amount of hours per day every week, then the workpattern is regular.
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          shift:
                            description: |
                              The shift determines the full-time hours and bonus percentage.

                              `shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metaData
                            nullable: false
                            properties:
                              bonusPercentage:
                                description: |
                                  The bonus percentage used in wage calculations for the hours made in this shift.
                                example: 12
                                maximum: 99
                                minimum: 0.01
                                nullable: false
                                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
                                nullable: false
                                readOnly: true
                                type: number
                              shiftNumber:
                                description: |
                                  The number for the shift.
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          shiftRateSickLeave:
                            description: |
                              The shift determines the full-time hours and bonus percentage.

                              `shiftRateSickLeave` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                            format: metadata
                            properties:
                              bonusPercentage:
                                description: |
                                  The bonus percentage used in wage calculations for the hours made in this shift.
                                example: 12
                                maximum: 99
                                minimum: 1
                                nullable: false
                                readOnly: true
                                type: number
                              fullTimeHoursPerWeek:
                                description: |
                                  The full time hours for an employment that is linked to this shift.
                                example: 40
                                maximum: 99
                                minimum: 1
                                nullable: false
                                readOnly: true
                                type: number
                              shiftNumber:
                                description: |
                                  The key number to identify the shift to be used for calculation of daily rate in case of sick leave (ziekte).
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          startDate:
                            description: |
                              Start date of the record.

                              A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          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. <br /> Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                            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
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the working hours for an employment
      tags:
        - Working hours
  "/providers/employers/employees/employments/{employmentId}/yearendstatements":
    get:
      description: |
        __Activity name :__ GetYearEndStatementsByEmploymentId

        Get a list of year-end statements (i.e. list of years for which year-end statements are available) for an employment
      operationId: GetYearEndStatementsByEmploymentId
      parameters:
        - description: The unique identifier of the employment
          in: path
          name: employmentId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            year:
                              description: The year for which a year-end statement is available.
                              example: 2018
                              format: int32
                              nullable: false
                              readOnly: true
                              type: integer
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Year-end statements for the employment
      tags:
        - Year-end statement
  "/providers/employers/employees/employments/{employmentId}/yearendstatements/{year}":
    get:
      description: |
        __Activity name :__ GetYearEndStatementForYearByEmploymentId

        Download the year-end statement of an employment for a year.
      operationId: GetYearEndStatementForYearByEmploymentId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 employment
          in: path
          name: employmentId
          required: true
          schema:
            format: uuid
            type: string
        - description: The payroll year
          in: path
          name: year
          required: true
          schema:
            example: 2018
            format: int32
            maxLength: 4
            type: integer
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download year-end statement of an employment for a year
      tags:
        - Year-end statement
  "/providers/employers/employees/notes/{noteId}":
    delete:
      description: |
        __Activity name :__ DeleteEmployeeNoteByNoteId

        Delete an existing note record
      operationId: DeleteEmployeeNoteByNoteId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: noteId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employee note record
      tags:
        - Employee notes
    get:
      description: |
        __Activity name :__ GetEmployeeNoteByNoteId

        Get the details of a note
      operationId: GetEmployeeNoteByNoteId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: noteId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            accessibleBy:
                              description: |
                                Indicates who can view this node.
                              nullable: false
                              properties:
                                key:
                                  description: The key for accessible by
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: Description of the accessible by
                                  example: Everyone
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            createdBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            createdOn:
                              description: |
                                The date on which the note was created
                              example: 2018-01-01
                              format: date-time
                              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
                            lastModifiedBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            lastModifiedOn:
                              description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                              example: 2018-01-01
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            note:
                              description: |-
                                The note it self.

                                __Note:__ This is a free text field so users can add htlm/script etc.
                              example: Remember to do xyz
                              maxLength: 4000
                              nullable: true
                              readOnly: false
                              type: string
                            subject:
                              description: subject of the note
                              example: Remember to do xyz
                              maxLength: 250
                              nullable: false
                              readOnly: false
                              type: string
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employee note
      tags:
        - Employee notes
    put:
      description: |
        __Activity name :__ PutEmployeeNoteByNoteId

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.
      operationId: PutEmployeeNoteByNoteId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: noteId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                accessibleBy:
                  description: |
                    Indicates who can view this node.
                  nullable: false
                  properties:
                    key:
                      description: The key for accessible by
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: Description of the accessible by
                      example: Everyone
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                createdBy:
                  format: metadata
                  nullable: true
                  properties:
                    formattedName:
                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                createdOn:
                  description: |
                    The date on which the note was created
                  example: 2018-01-01
                  format: date-time
                  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
                lastModifiedBy:
                  format: metadata
                  nullable: true
                  properties:
                    formattedName:
                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                lastModifiedOn:
                  description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                  example: 2018-01-01
                  format: date-time
                  nullable: false
                  readOnly: true
                  type: string
                note:
                  description: |-
                    The note it self.

                    __Note:__ This is a free text field so users can add htlm/script etc.
                  example: Remember to do xyz
                  maxLength: 4000
                  nullable: true
                  readOnly: false
                  type: string
                subject:
                  description: subject of the note
                  example: Remember to do xyz
                  maxLength: 250
                  nullable: false
                  readOnly: false
                  type: string
              type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          accessibleBy:
                            description: |
                              Indicates who can view this node.
                            nullable: false
                            properties:
                              key:
                                description: The key for accessible by
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: Description of the accessible by
                                example: Everyone
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          createdBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          createdOn:
                            description: |
                              The date on which the note was created
                            example: 2018-01-01
                            format: date-time
                            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
                          lastModifiedBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          lastModifiedOn:
                            description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                            example: 2018-01-01
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          note:
                            description: |-
                              The note it self.

                              __Note:__ This is a free text field so users can add htlm/script etc.
                            example: Remember to do xyz
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          subject:
                            description: subject of the note
                            example: Remember to do xyz
                            maxLength: 250
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit an employee note record
      tags:
        - Employee notes
  "/providers/employers/employees/partners/{partnerId}":
    delete:
      description: |
        __Activity name :__ DeletePartnerByPartnerId

        Delete an existing partner
      operationId: DeletePartnerByPartnerId
      parameters:
        - description: The unique identifier of a partner
          in: path
          name: partnerId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 partner record
      tags:
        - Partner
    get:
      description: |
        __Activity name :__ GetPartnerByPartnerId

        Get the details of a single partner
      operationId: GetPartnerByPartnerId
      parameters:
        - description: The unique identifier of a partner
          in: path
          name: partnerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          dateOfBirth:
                            description: |
                              The date of birth
                            example: 1995-05-21
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          dateOfDeath:
                            description: |
                              The date of death
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          endDate:
                            description: end date
                            example: 1995-05-21
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          firstName:
                            description: |
                              The first name, given name, forename or Christian name as part of a persons personal name.
                            example: Susan
                            maxLength: 28
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          gender:
                            description: |
                              The gender
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: female
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          howToFormatLastName:
                            description: |
                              Indicates how the system will format the last name.
                            format: metadata
                            nullable: false
                            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
                            readOnly: false
                            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
                          initials:
                            description: |
                              The initials
                            example: S.L.
                            maxLength: 6
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          lastName:
                            description: |
                              The last name, family name or surname as part of a persons personal name.
                            example: Bergen
                            maxLength: 25
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          placeOfBirth:
                            description: |
                              The place of birth
                            example: Amsterdam
                            maxLength: 24
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          prefix:
                            description: |
                              The prefix to the last name
                            example: van
                            maxLength: 10
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          startDate:
                            description: startdate
                            example: 1995-05-21
                            format: date
                            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
                            readOnly: false
                            type: object
                          waoClassification:
                            description: The occupational disability classification in the form of a percentage range.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                description: |
                                  The key of the occupational disability classification. Possible values can be acquired via the metadata endpoint.
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  Description of the occupational disability classification.
                                example: 15 - 24
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 single partner
      tags:
        - Partner
    put:
      description: |
        __Activity name :__ PutPartnerByPartnerId

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.

        Edit the partner information
      operationId: PutPartnerByPartnerId
      parameters:
        - description: The unique identifier of a partner
          in: path
          name: partnerId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                dateOfBirth:
                  description: |
                    The date of birth
                  example: 1995-05-21
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                dateOfDeath:
                  description: |
                    The date of death
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                endDate:
                  description: end date
                  example: 1995-05-21
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                firstName:
                  description: |
                    The first name, given name, forename or Christian name as part of a persons personal name.
                  example: Susan
                  maxLength: 28
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                gender:
                  description: |
                    The gender
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: female
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
                howToFormatLastName:
                  description: |
                    Indicates how the system will format the last name.
                  format: metadata
                  nullable: false
                  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
                  readOnly: false
                  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
                initials:
                  description: |
                    The initials
                  example: S.L.
                  maxLength: 6
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                lastName:
                  description: |
                    The last name, family name or surname as part of a persons personal name.
                  example: Bergen
                  maxLength: 25
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                placeOfBirth:
                  description: |
                    The place of birth
                  example: Amsterdam
                  maxLength: 24
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                prefix:
                  description: |
                    The prefix to the last name
                  example: van
                  maxLength: 10
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                startDate:
                  description: startdate
                  example: 1995-05-21
                  format: date
                  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
                  readOnly: false
                  type: object
                waoClassification:
                  description: The occupational disability classification in the form of a percentage range.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      description: |
                        The key of the occupational disability classification. Possible values can be acquired via the metadata endpoint.
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        Description of the occupational disability classification.
                      example: 15 - 24
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
              type: object
        description: Partner 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          dateOfBirth:
                            description: |
                              The date of birth
                            example: 1995-05-21
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          dateOfDeath:
                            description: |
                              The date of death
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          endDate:
                            description: end date
                            example: 1995-05-21
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          firstName:
                            description: |
                              The first name, given name, forename or Christian name as part of a persons personal name.
                            example: Susan
                            maxLength: 28
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          gender:
                            description: |
                              The gender
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: female
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          howToFormatLastName:
                            description: |
                              Indicates how the system will format the last name.
                            format: metadata
                            nullable: false
                            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
                            readOnly: false
                            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
                          initials:
                            description: |
                              The initials
                            example: S.L.
                            maxLength: 6
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          lastName:
                            description: |
                              The last name, family name or surname as part of a persons personal name.
                            example: Bergen
                            maxLength: 25
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          placeOfBirth:
                            description: |
                              The place of birth
                            example: Amsterdam
                            maxLength: 24
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          prefix:
                            description: |
                              The prefix to the last name
                            example: van
                            maxLength: 10
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          startDate:
                            description: startdate
                            example: 1995-05-21
                            format: date
                            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
                            readOnly: false
                            type: object
                          waoClassification:
                            description: The occupational disability classification in the form of a percentage range.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                description: |
                                  The key of the occupational disability classification. Possible values can be acquired via the metadata endpoint.
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  Description of the occupational disability classification.
                                example: 15 - 24
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details for a partner
      tags:
        - Partner
  /providers/employers/employees/selfservice:
    patch:
      description: |
        __Activity name :__ PatchEmployeeSelfServiceAccessByEmployeeId

        This endpoint allows the user to change the status of access for the employee's to ESS (Werknemer.loket).
      operationId: PatchEmployeeSelfServiceAccessByEmployeeId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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:
                  action:
                    description: The action to be taken for the given employee
                    enum:
                      - SendInvite
                      - RevokeInvite
                      - RevokeAccess
                      - ReinstateAccess
                      - ResendUsername
                      - DisableTwoFactorAuthentication
                    maxLength: 50
                    nullable: false
                    readOnly: false
                    type: string
                  employeeId:
                    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
              type: array
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Change the employee's self service (ESS) access
      tags:
        - Employee self service
  "/providers/employers/employees/{employeeId}":
    get:
      description: |
        __Activity name :__ GetEmployeeByEmployeeId

        Get the details of a single employee
      operationId: GetEmployeeByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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-12-31:
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          address:
                            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
                              furtherIndication:
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    description: The key of the further indication ('nadere aanduiding'). 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 ('nadere aanduiding'), 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, 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: false
                                readOnly: false
                                type: string
                            type: object
                          contactInformation:
                            nullable: false
                            properties:
                              emailAddress:
                                description: The e-mail address of the employee.
                                example: info@loket.nl
                                maxLength: 255
                                nullable: true
                                pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                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:
                            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: false
                                    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
                              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
                          employeeNumber:
                            description: |
                              The employee number to uniquely identify an employee within an employer
                            example: 156
                            format: int32
                            minimum: 1
                            nullable: false
                            readOnly: false
                            type: integer
                          exclusionFromAbsenceStatus:
                            description: |
                              Indicates whether the employee is excluded for any information of absence
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          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
                          identityDocument:
                            nullable: true
                            properties:
                              documentIdentification:
                                example: CRE45553433
                                nullable: false
                                readOnly: false
                                type: string
                              typeOfDocument:
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: The key for the type of document. Posible values can be aquired 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
                            readOnly: false
                            type: object
                          personalDetails:
                            nullable: false
                            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: 2062-08-21
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              civilStatus:
                                description: |
                                  The civil/marital status of the employee
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Maried
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              dateOfBirth:
                                description: |
                                  The date of birth
                                example: 1995-05-21
                                format: date
                                nullable: false
                                readOnly: false
                                type: string
                              dateOfDeath:
                                description: |
                                  The date of death
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              firstName:
                                description: |
                                  The first name, given name, forename or Christian name as part of a persons personal name.
                                example: Susan
                                maxLength: 28
                                minLength: 1
                                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: false
                                readOnly: true
                                type: string
                              gender:
                                description: |
                                  The gender
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: female
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: false
                                type: object
                              howToFormatLastName:
                                description: |
                                  Indicates how the system will format the last name.
                                format: metadata
                                nullable: false
                                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
                                readOnly: false
                                type: object
                              initials:
                                description: |
                                  The initials
                                example: S.L.
                                maxLength: 6
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              lastName:
                                description: |
                                  The last name, family name or surname as part of a persons personal name.
                                example: Bergen
                                maxLength: 25
                                minLength: 1
                                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:
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    description: The key for the nationality. Posible values can be aquired via the metadata endpoint
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: Description of the nationality
                                    example: Dutch
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: false
                                type: object
                              photo:
                                description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                format: url
                                nullable: true
                                readOnly: true
                                type: string
                              placeOfBirth:
                                description: |
                                  The place of birth
                                example: Amsterdam
                                maxLength: 24
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              prefix:
                                description: |
                                  The prefix to the last name
                                example: van
                                maxLength: 10
                                minLength: 1
                                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
                                readOnly: false
                                type: object
                            readOnly: false
                            type: object
                          revokeEmployeeSelfServiceAccessOn:
                            description: |
                              The date on which the Employee will be automatically blocked.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          statusEmployeeSelfService:
                            description: The status of the accessability of the Employee Self Service application. In case ESS is not relevant the object will be returned as NULL. Possible values can be acquired via the metadata endpoint
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Blocked
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          travel:
                            nullable: false
                            properties:
                              travelDistanceToWork:
                                description: |
                                  The one way distance in metres the employee has to travel to work.
                                example: 32
                                format: int32
                                minimum: 1
                                nullable: true
                                readOnly: false
                                type: integer
                            readOnly: false
                            type: object
                    type: object
            application/json;version=2021-03-29:
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          address:
                            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
                              furtherIndication:
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    description: The key of the further indication ('nadere aanduiding'). 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 ('nadere aanduiding'), 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, 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: false
                                readOnly: false
                                type: string
                            type: object
                          contactInformation:
                            nullable: false
                            properties:
                              businessEmailAddress:
                                description: The business e-mail address of the employee.
                                example: info@loket.nl
                                maxLength: 255
                                nullable: true
                                pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                readOnly: false
                                type: string
                              businessMobilePhoneNumber:
                                description: The business mobile phone number of the employee.
                                example: +31 6-1231456
                                maxLength: 15
                                nullable: true
                                readOnly: false
                                type: string
                              businessPhoneNumber:
                                description: The business phone number of the employee.
                                example: +31 13-1234567
                                maxLength: 15
                                nullable: true
                                readOnly: false
                                type: string
                              emailAddress:
                                description: The e-mail address of the employee.
                                example: info@loket.nl
                                maxLength: 255
                                nullable: true
                                pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                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:
                            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: false
                                    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
                              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
                          employeeNumber:
                            description: |
                              The employee number to uniquely identify an employee within an employer
                            example: 156
                            format: int32
                            minimum: 1
                            nullable: false
                            readOnly: false
                            type: integer
                          exclusionFromAbsenceStatus:
                            description: |
                              Indicates whether the employee is excluded for any information of absence
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          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
                          identityDocument:
                            nullable: true
                            properties:
                              documentIdentification:
                                example: CRE45553433
                                nullable: false
                                readOnly: false
                                type: string
                              typeOfDocument:
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: The key for the type of document. Posible values can be aquired 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
                            readOnly: false
                            type: object
                          personalDetails:
                            nullable: false
                            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: 2062-08-21
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              civilStatus:
                                description: |
                                  The civil/marital status of the employee
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Maried
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              dateOfBirth:
                                description: |
                                  The date of birth
                                example: 1995-05-21
                                format: date
                                nullable: false
                                readOnly: false
                                type: string
                              dateOfDeath:
                                description: |
                                  The date of death
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              firstName:
                                description: |
                                  The first name, given name, forename or Christian name as part of a persons personal name.
                                example: Susan
                                maxLength: 28
                                minLength: 1
                                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: false
                                readOnly: true
                                type: string
                              gender:
                                description: |
                                  The gender
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: female
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: false
                                type: object
                              howToFormatLastName:
                                description: |
                                  Indicates how the system will format the last name.
                                format: metadata
                                nullable: false
                                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
                                readOnly: false
                                type: object
                              initials:
                                description: |
                                  The initials
                                example: S.L.
                                maxLength: 6
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              lastName:
                                description: |
                                  The last name, family name or surname as part of a persons personal name.
                                example: Bergen
                                maxLength: 25
                                minLength: 1
                                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:
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    description: The key for the nationality. Posible values can be aquired via the metadata endpoint
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: Description of the nationality
                                    example: Dutch
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: false
                                type: object
                              photo:
                                description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                format: url
                                nullable: true
                                readOnly: true
                                type: string
                              placeOfBirth:
                                description: |
                                  The place of birth
                                example: Amsterdam
                                maxLength: 24
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              prefix:
                                description: |
                                  The prefix to the last name
                                example: van
                                maxLength: 10
                                minLength: 1
                                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
                                readOnly: false
                                type: object
                            readOnly: false
                            type: object
                          revokeEmployeeSelfServiceAccessOn:
                            description: |
                              The date on which the Employee will be automatically blocked.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          statusEmployeeSelfService:
                            description: The status of the accessability of the Employee Self Service application. In case ESS is not relevant the object will be returned as NULL. Possible values can be acquired via the metadata endpoint
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Blocked
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          travel:
                            nullable: false
                            properties:
                              travelDistanceToWork:
                                description: |
                                  The one way distance in metres the employee has to travel to work.
                                example: 32
                                format: int32
                                minimum: 1
                                nullable: true
                                readOnly: false
                                type: integer
                            readOnly: false
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employee
      tags:
        - Employee
    put:
      description: |
        __Activity name :__ PutEmployeeByEmployeeId


        Edit the employee details
        <br />
        Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the URL
      operationId: PutEmployeeByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-12-31:
            schema:
              properties:
                address:
                  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
                    furtherIndication:
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          description: The key of the further indication ('nadere aanduiding'). 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 ('nadere aanduiding'), 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, 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: false
                      readOnly: false
                      type: string
                  type: object
                contactInformation:
                  nullable: false
                  properties:
                    emailAddress:
                      description: The e-mail address of the employee.
                      example: info@loket.nl
                      maxLength: 255
                      nullable: true
                      pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                      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:
                  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: false
                          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
                    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
                employeeNumber:
                  description: |
                    The employee number to uniquely identify an employee within an employer
                  example: 156
                  format: int32
                  minimum: 1
                  nullable: false
                  readOnly: false
                  type: integer
                exclusionFromAbsenceStatus:
                  description: |
                    Indicates whether the employee is excluded for any information of absence
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                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
                identityDocument:
                  nullable: true
                  properties:
                    documentIdentification:
                      example: CRE45553433
                      nullable: false
                      readOnly: false
                      type: string
                    typeOfDocument:
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          description: The key for the type of document. Posible values can be aquired 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
                  readOnly: false
                  type: object
                personalDetails:
                  nullable: false
                  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: 2062-08-21
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    civilStatus:
                      description: |
                        The civil/marital status of the employee
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: Maried
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    dateOfBirth:
                      description: |
                        The date of birth
                      example: 1995-05-21
                      format: date
                      nullable: false
                      readOnly: false
                      type: string
                    dateOfDeath:
                      description: |
                        The date of death
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    firstName:
                      description: |
                        The first name, given name, forename or Christian name as part of a persons personal name.
                      example: Susan
                      maxLength: 28
                      minLength: 1
                      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: false
                      readOnly: true
                      type: string
                    gender:
                      description: |
                        The gender
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: female
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: false
                      type: object
                    howToFormatLastName:
                      description: |
                        Indicates how the system will format the last name.
                      format: metadata
                      nullable: false
                      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
                      readOnly: false
                      type: object
                    initials:
                      description: |
                        The initials
                      example: S.L.
                      maxLength: 6
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    lastName:
                      description: |
                        The last name, family name or surname as part of a persons personal name.
                      example: Bergen
                      maxLength: 25
                      minLength: 1
                      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:
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          description: The key for the nationality. Posible values can be aquired via the metadata endpoint
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          description: Description of the nationality
                          example: Dutch
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: false
                      type: object
                    photo:
                      description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                      example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                      format: url
                      nullable: true
                      readOnly: true
                      type: string
                    placeOfBirth:
                      description: |
                        The place of birth
                      example: Amsterdam
                      maxLength: 24
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                    prefix:
                      description: |
                        The prefix to the last name
                      example: van
                      maxLength: 10
                      minLength: 1
                      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
                      readOnly: false
                      type: object
                  readOnly: false
                  type: object
                revokeEmployeeSelfServiceAccessOn:
                  description: |
                    The date on which the Employee will be automatically blocked.
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: true
                  type: string
                statusEmployeeSelfService:
                  description: The status of the accessability of the Employee Self Service application. In case ESS is not relevant the object will be returned as NULL. Possible values can be acquired via the metadata endpoint
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    value:
                      example: Blocked
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                travel:
                  nullable: false
                  properties:
                    travelDistanceToWork:
                      description: |
                        The one way distance in metres the employee has to travel to work.
                      example: 32
                      format: int32
                      minimum: 1
                      nullable: true
                      readOnly: false
                      type: integer
                  readOnly: false
                  type: object
          application/json;version=2021-03-29:
            schema:
              properties:
                address:
                  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
                    furtherIndication:
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          description: The key of the further indication ('nadere aanduiding'). 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 ('nadere aanduiding'), 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, 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: false
                      readOnly: false
                      type: string
                  type: object
                contactInformation:
                  nullable: false
                  properties:
                    businessEmailAddress:
                      description: The business e-mail address of the employee.
                      example: info@loket.nl
                      maxLength: 255
                      nullable: true
                      pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                      readOnly: false
                      type: string
                    businessMobilePhoneNumber:
                      description: The business mobile phone number of the employee.
                      example: +31 6-1231456
                      maxLength: 15
                      nullable: true
                      readOnly: false
                      type: string
                    businessPhoneNumber:
                      description: The business phone number of the employee.
                      example: +31 13-1234567
                      maxLength: 15
                      nullable: true
                      readOnly: false
                      type: string
                    emailAddress:
                      description: The e-mail address of the employee.
                      example: info@loket.nl
                      maxLength: 255
                      nullable: true
                      pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                      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:
                  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: false
                          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
                    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
                employeeNumber:
                  description: |
                    The employee number to uniquely identify an employee within an employer
                  example: 156
                  format: int32
                  minimum: 1
                  nullable: false
                  readOnly: false
                  type: integer
                exclusionFromAbsenceStatus:
                  description: |
                    Indicates whether the employee is excluded for any information of absence
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                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
                identityDocument:
                  nullable: true
                  properties:
                    documentIdentification:
                      example: CRE45553433
                      nullable: false
                      readOnly: false
                      type: string
                    typeOfDocument:
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          description: The key for the type of document. Posible values can be aquired 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
                  readOnly: false
                  type: object
                personalDetails:
                  nullable: false
                  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: 2062-08-21
                      format: date
                      nullable: false
                      readOnly: true
                      type: string
                    civilStatus:
                      description: |
                        The civil/marital status of the employee
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: Maried
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    dateOfBirth:
                      description: |
                        The date of birth
                      example: 1995-05-21
                      format: date
                      nullable: false
                      readOnly: false
                      type: string
                    dateOfDeath:
                      description: |
                        The date of death
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    firstName:
                      description: |
                        The first name, given name, forename or Christian name as part of a persons personal name.
                      example: Susan
                      maxLength: 28
                      minLength: 1
                      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: false
                      readOnly: true
                      type: string
                    gender:
                      description: |
                        The gender
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: female
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: false
                      type: object
                    howToFormatLastName:
                      description: |
                        Indicates how the system will format the last name.
                      format: metadata
                      nullable: false
                      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
                      readOnly: false
                      type: object
                    initials:
                      description: |
                        The initials
                      example: S.L.
                      maxLength: 6
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    lastName:
                      description: |
                        The last name, family name or surname as part of a persons personal name.
                      example: Bergen
                      maxLength: 25
                      minLength: 1
                      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:
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          description: The key for the nationality. Posible values can be aquired via the metadata endpoint
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          description: Description of the nationality
                          example: Dutch
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: false
                      type: object
                    photo:
                      description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                      example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                      format: url
                      nullable: true
                      readOnly: true
                      type: string
                    placeOfBirth:
                      description: |
                        The place of birth
                      example: Amsterdam
                      maxLength: 24
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                    prefix:
                      description: |
                        The prefix to the last name
                      example: van
                      maxLength: 10
                      minLength: 1
                      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
                      readOnly: false
                      type: object
                  readOnly: false
                  type: object
                revokeEmployeeSelfServiceAccessOn:
                  description: |
                    The date on which the Employee will be automatically blocked.
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: true
                  type: string
                statusEmployeeSelfService:
                  description: The status of the accessability of the Employee Self Service application. In case ESS is not relevant the object will be returned as NULL. Possible values can be acquired via the metadata endpoint
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    value:
                      example: Blocked
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                travel:
                  nullable: false
                  properties:
                    travelDistanceToWork:
                      description: |
                        The one way distance in metres the employee has to travel to work.
                      example: 32
                      format: int32
                      minimum: 1
                      nullable: true
                      readOnly: false
                      type: integer
                  readOnly: false
                  type: object
        description: Employee to edit.
        required: true
      responses:
        "200":
          content:
            application/json;version=2018-12-31:
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          address:
                            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
                              furtherIndication:
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    description: The key of the further indication ('nadere aanduiding'). 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 ('nadere aanduiding'), 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, 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: false
                                readOnly: false
                                type: string
                            type: object
                          contactInformation:
                            nullable: false
                            properties:
                              emailAddress:
                                description: The e-mail address of the employee.
                                example: info@loket.nl
                                maxLength: 255
                                nullable: true
                                pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                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:
                            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: false
                                    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
                              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
                          employeeNumber:
                            description: |
                              The employee number to uniquely identify an employee within an employer
                            example: 156
                            format: int32
                            minimum: 1
                            nullable: false
                            readOnly: false
                            type: integer
                          exclusionFromAbsenceStatus:
                            description: |
                              Indicates whether the employee is excluded for any information of absence
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          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
                          identityDocument:
                            nullable: true
                            properties:
                              documentIdentification:
                                example: CRE45553433
                                nullable: false
                                readOnly: false
                                type: string
                              typeOfDocument:
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: The key for the type of document. Posible values can be aquired 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
                            readOnly: false
                            type: object
                          personalDetails:
                            nullable: false
                            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: 2062-08-21
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              civilStatus:
                                description: |
                                  The civil/marital status of the employee
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Maried
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              dateOfBirth:
                                description: |
                                  The date of birth
                                example: 1995-05-21
                                format: date
                                nullable: false
                                readOnly: false
                                type: string
                              dateOfDeath:
                                description: |
                                  The date of death
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              firstName:
                                description: |
                                  The first name, given name, forename or Christian name as part of a persons personal name.
                                example: Susan
                                maxLength: 28
                                minLength: 1
                                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: false
                                readOnly: true
                                type: string
                              gender:
                                description: |
                                  The gender
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: female
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: false
                                type: object
                              howToFormatLastName:
                                description: |
                                  Indicates how the system will format the last name.
                                format: metadata
                                nullable: false
                                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
                                readOnly: false
                                type: object
                              initials:
                                description: |
                                  The initials
                                example: S.L.
                                maxLength: 6
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              lastName:
                                description: |
                                  The last name, family name or surname as part of a persons personal name.
                                example: Bergen
                                maxLength: 25
                                minLength: 1
                                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:
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    description: The key for the nationality. Posible values can be aquired via the metadata endpoint
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: Description of the nationality
                                    example: Dutch
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: false
                                type: object
                              photo:
                                description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                format: url
                                nullable: true
                                readOnly: true
                                type: string
                              placeOfBirth:
                                description: |
                                  The place of birth
                                example: Amsterdam
                                maxLength: 24
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              prefix:
                                description: |
                                  The prefix to the last name
                                example: van
                                maxLength: 10
                                minLength: 1
                                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
                                readOnly: false
                                type: object
                            readOnly: false
                            type: object
                          revokeEmployeeSelfServiceAccessOn:
                            description: |
                              The date on which the Employee will be automatically blocked.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          statusEmployeeSelfService:
                            description: The status of the accessability of the Employee Self Service application. In case ESS is not relevant the object will be returned as NULL. Possible values can be acquired via the metadata endpoint
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Blocked
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          travel:
                            nullable: false
                            properties:
                              travelDistanceToWork:
                                description: |
                                  The one way distance in metres the employee has to travel to work.
                                example: 32
                                format: int32
                                minimum: 1
                                nullable: true
                                readOnly: false
                                type: integer
                            readOnly: false
                            type: object
                    type: object
            application/json;version=2021-03-29:
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          address:
                            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
                              furtherIndication:
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    description: The key of the further indication ('nadere aanduiding'). 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 ('nadere aanduiding'), 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, 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: false
                                readOnly: false
                                type: string
                            type: object
                          contactInformation:
                            nullable: false
                            properties:
                              businessEmailAddress:
                                description: The business e-mail address of the employee.
                                example: info@loket.nl
                                maxLength: 255
                                nullable: true
                                pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                readOnly: false
                                type: string
                              businessMobilePhoneNumber:
                                description: The business mobile phone number of the employee.
                                example: +31 6-1231456
                                maxLength: 15
                                nullable: true
                                readOnly: false
                                type: string
                              businessPhoneNumber:
                                description: The business phone number of the employee.
                                example: +31 13-1234567
                                maxLength: 15
                                nullable: true
                                readOnly: false
                                type: string
                              emailAddress:
                                description: The e-mail address of the employee.
                                example: info@loket.nl
                                maxLength: 255
                                nullable: true
                                pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                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:
                            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: false
                                    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
                              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
                          employeeNumber:
                            description: |
                              The employee number to uniquely identify an employee within an employer
                            example: 156
                            format: int32
                            minimum: 1
                            nullable: false
                            readOnly: false
                            type: integer
                          exclusionFromAbsenceStatus:
                            description: |
                              Indicates whether the employee is excluded for any information of absence
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          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
                          identityDocument:
                            nullable: true
                            properties:
                              documentIdentification:
                                example: CRE45553433
                                nullable: false
                                readOnly: false
                                type: string
                              typeOfDocument:
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: The key for the type of document. Posible values can be aquired 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
                            readOnly: false
                            type: object
                          personalDetails:
                            nullable: false
                            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: 2062-08-21
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              civilStatus:
                                description: |
                                  The civil/marital status of the employee
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Maried
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              dateOfBirth:
                                description: |
                                  The date of birth
                                example: 1995-05-21
                                format: date
                                nullable: false
                                readOnly: false
                                type: string
                              dateOfDeath:
                                description: |
                                  The date of death
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              firstName:
                                description: |
                                  The first name, given name, forename or Christian name as part of a persons personal name.
                                example: Susan
                                maxLength: 28
                                minLength: 1
                                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: false
                                readOnly: true
                                type: string
                              gender:
                                description: |
                                  The gender
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: female
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: false
                                type: object
                              howToFormatLastName:
                                description: |
                                  Indicates how the system will format the last name.
                                format: metadata
                                nullable: false
                                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
                                readOnly: false
                                type: object
                              initials:
                                description: |
                                  The initials
                                example: S.L.
                                maxLength: 6
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              lastName:
                                description: |
                                  The last name, family name or surname as part of a persons personal name.
                                example: Bergen
                                maxLength: 25
                                minLength: 1
                                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:
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    description: The key for the nationality. Posible values can be aquired via the metadata endpoint
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: Description of the nationality
                                    example: Dutch
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: false
                                type: object
                              photo:
                                description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                format: url
                                nullable: true
                                readOnly: true
                                type: string
                              placeOfBirth:
                                description: |
                                  The place of birth
                                example: Amsterdam
                                maxLength: 24
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              prefix:
                                description: |
                                  The prefix to the last name
                                example: van
                                maxLength: 10
                                minLength: 1
                                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
                                readOnly: false
                                type: object
                            readOnly: false
                            type: object
                          revokeEmployeeSelfServiceAccessOn:
                            description: |
                              The date on which the Employee will be automatically blocked.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          statusEmployeeSelfService:
                            description: The status of the accessability of the Employee Self Service application. In case ESS is not relevant the object will be returned as NULL. Possible values can be acquired via the metadata endpoint
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Blocked
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          travel:
                            nullable: false
                            properties:
                              travelDistanceToWork:
                                description: |
                                  The one way distance in metres the employee has to travel to work.
                                example: 32
                                format: int32
                                minimum: 1
                                nullable: true
                                readOnly: false
                                type: integer
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Edit the details of an employee
      tags:
        - Employee
  "/providers/employers/employees/{employeeId}/absences":
    get:
      description: |
        __Activity name :__ GetAbsencesByEmployeeId

        Get a list of all absences for the given employee
      operationId: GetAbsencesByEmployeeId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 employee
          in: path
          name: employeeId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          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).
                              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:

                                  1) Illness/sickness

                                  2) "Vangnet" such as maternity leave, organ donation or adoption leave


                                Other absences such as Vacation days, unpayed leave and Personal leave are registerd using the leave endpoint
                              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: 2018-01-21
                                  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: 2018-01-21
                              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: 2018-04-21
                              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`. 
                                When `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.
                                      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: 2018-01-21
                                  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.
                                  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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 absences for an employee
      tags:
        - Absence
    post:
      description: |
        __Activity name :__ PostAbsenceByEmployeeId

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL. 

        Add an Absence (=verzuimmelding) for an employee. 

        __Please note that if this endpoint is called succesfully both an absence (=verzuimmelding) AND one underlying absence progress (=verzuimverloop) will be created.__
      operationId: PostAbsenceByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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).
                  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:

                      1) Illness/sickness

                      2) "Vangnet" such as maternity leave, organ donation or adoption leave


                    Other absences such as Vacation days, unpayed leave and Personal leave are registerd using the leave endpoint
                  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: 2018-01-21
                      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: 2018-01-21
                  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: 2018-04-21
                  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`. 
                    When `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: false
                      type: integer
                    startDate:
                      description: start dat of the incapacityPercentage
                      example: 2018-01-21
                      format: date
                      nullable: false
                      readOnly: false
                      type: string
                  type: object
                reintegration:
                  nullable: true
                  properties:
                    dateOfFinalizingPlanOfAction:
                      description: |
                        The day on which a plan of action (for return to normal work) was finalized.
                      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: Add an Absence for an employee.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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).
                            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:

                                1) Illness/sickness

                                2) "Vangnet" such as maternity leave, organ donation or adoption leave


                              Other absences such as Vacation days, unpayed leave and Personal leave are registerd using the leave endpoint
                            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: 2018-01-21
                                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: 2018-01-21
                            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: 2018-04-21
                            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`. 
                              When `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.
                                    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: 2018-01-21
                                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.
                                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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 for an employee
      tags:
        - Absence
  "/providers/employers/employees/{employeeId}/absences/overview":
    get:
      description: |
        __Activity name :__ GetAbsenceOverviewByEmployeeId

        Download the absence overview (verzuim) for a given time frame

        __Metadata :__ No metadata
      operationId: GetAbsenceOverviewByEmployeeId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 employee
          in: path
          name: employeeId
          required: true
          schema:
            format: uuid
            type: string
        - description: The start date
          in: query
          name: startDate
          required: true
          schema:
            example: 2020-08-01
            pattern: date
            type: string
        - description: The end date
          in: query
          name: endDate
          required: true
          schema:
            example: 2020-08-31
            pattern: date
            type: string
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download the absence overview for an employee
      tags:
        - Absence
  "/providers/employers/employees/{employeeId}/benifyurl":
    get:
      description: |
        __Activity name :__ GetBenifyUrlByEmployeeId

        Get a URL to access the Benify portal for an employee.
      operationId: GetBenifyUrlByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          url:
                            description: The URL to access the Benify portal
                            example: https://www.benify.nl
                            format: url
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 Benify URL for an employee
      tags:
        - Employee benefits
  "/providers/employers/employees/{employeeId}/changeaddressrequest":
    post:
      description: |
        __Activity name:__ PostChangeAddressRequestByEmployeeId
          

        Allows the user to submit a change address request. Request because this request will trigger a workflow that might require the change to be approved.

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostChangeAddressRequestByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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:
                  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, 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: false
                      readOnly: false
                      type: string
                  type: object
                comment:
                  description: An extra comment for the change request
                  example: We move house September 26th
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
              type: object
        description: Data to as input for the workflow (the new address)
        required: true
      responses:
        "202":
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Accepted
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Start the change address workflow for an employee
      tags:
        - Change address request
  "/providers/employers/employees/{employeeId}/changecontactinformationrequest":
    post:
      description: |
        __Activity name:__ PostChangeContactInformationRequestByEmployeeId
          

        Allows the user to submit a change contactinformation request. Request because this request will trigger a workflow that might require the change to be approved.
      operationId: PostChangeContactInformationRequestByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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:
                comment:
                  description: An extra comment for the change request
                  example: Changed my mobile phone number.
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                contactInformation:
                  nullable: false
                  properties:
                    emailAddress:
                      description: The e-mail address of the employee. This field is required when the product Employee Self Serve is used.
                      example: info@loket.nl
                      maxLength: 255
                      nullable: true
                      pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                      readOnly: false
                      type: string
                    faxNumber:
                      description: The fax number of the employee
                      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
              type: object
        description: Data to serve as input for the workflow (the new contactinformation)
        required: true
      responses:
        "202":
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Accepted
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Start the change contactinformation workflow for an employee
      tags:
        - Change contactinformation request
  "/providers/employers/employees/{employeeId}/children":
    get:
      description: |
        __Activity name :__ GetChildrenByEmployeeId


         Get the list of children of the employee
      operationId: GetChildrenByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            dateOfBirth:
                              description: |
                                The date of birth
                              example: 1995-05-21
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            dateOfDeath:
                              description: |
                                The date of death
                              format: date
                              nullable: true
                              readOnly: false
                              type: string
                            firstName:
                              description: |
                                The first name, given name, forename or Christian name as part of a persons personal name.
                              example: Susan
                              maxLength: 28
                              minLength: 1
                              nullable: true
                              readOnly: false
                              type: string
                            gender:
                              description: |
                                The gender
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: female
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              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
                            initials:
                              description: |
                                The initials
                              example: S.L.
                              maxLength: 6
                              minLength: 1
                              nullable: false
                              readOnly: false
                              type: string
                            lastName:
                              description: |
                                The last name, family name or surname as part of a persons personal name.
                              example: Bergen
                              maxLength: 25
                              minLength: 1
                              nullable: false
                              readOnly: false
                              type: string
                            prefix:
                              description: |
                                The prefix to the last name
                              example: van
                              maxLength: 10
                              minLength: 1
                              nullable: true
                              readOnly: false
                              type: string
                            residenceStatus:
                              description: |
                                Indicator to tell if the child is living at home or not. Use null if unknown.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  description: The key for the residence status
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: Is the child living with his parent
                                  example: Living at home
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 children for an employee
      tags:
        - Child
    post:
      description: |
        __Activity name :__ PostChildByEmployeeId

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL. 

        Add a child for an employee
      operationId: PostChildByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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:
                dateOfBirth:
                  description: |
                    The date of birth
                  example: 1995-05-21
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                dateOfDeath:
                  description: |
                    The date of death
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                firstName:
                  description: |
                    The first name, given name, forename or Christian name as part of a persons personal name.
                  example: Susan
                  maxLength: 28
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                gender:
                  description: |
                    The gender
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: female
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  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
                initials:
                  description: |
                    The initials
                  example: S.L.
                  maxLength: 6
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                lastName:
                  description: |
                    The last name, family name or surname as part of a persons personal name.
                  example: Bergen
                  maxLength: 25
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                prefix:
                  description: |
                    The prefix to the last name
                  example: van
                  maxLength: 10
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                residenceStatus:
                  description: |
                    Indicator to tell if the child is living at home or not. Use null if unknown.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      description: The key for the residence status
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: Is the child living with his parent
                      example: Living at home
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
              type: object
        description: Add a child for an employee.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          dateOfBirth:
                            description: |
                              The date of birth
                            example: 1995-05-21
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          dateOfDeath:
                            description: |
                              The date of death
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          firstName:
                            description: |
                              The first name, given name, forename or Christian name as part of a persons personal name.
                            example: Susan
                            maxLength: 28
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          gender:
                            description: |
                              The gender
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: female
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            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
                          initials:
                            description: |
                              The initials
                            example: S.L.
                            maxLength: 6
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          lastName:
                            description: |
                              The last name, family name or surname as part of a persons personal name.
                            example: Bergen
                            maxLength: 25
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          prefix:
                            description: |
                              The prefix to the last name
                            example: van
                            maxLength: 10
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          residenceStatus:
                            description: |
                              Indicator to tell if the child is living at home or not. Use null if unknown.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                description: The key for the residence status
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: Is the child living with his parent
                                example: Living at home
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 child for an employee
      tags:
        - Child
  "/providers/employers/employees/{employeeId}/citizenservicenumber":
    get:
      description: |
        __Activity name :__ GetCitizenServiceNumberByEmployeeId

        Get the citizen service number of an employee. BSN is separately authorized in Loket and is therefore designed to have its own activities.
      operationId: GetCitizenServiceNumberByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 an employee
      tags:
        - Employee
    put:
      description: |
        __Activity name :__ PutCitizenServiceNumberByEmployeeId

        Update the citizen service number of an employee.  BSN is separately authorized in Loket and is therefore designed to have its own activities.
      operationId: PutCitizenServiceNumberByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Update the citizen service number of an employee
      tags:
        - Employee
  "/providers/employers/employees/{employeeId}/contacts":
    get:
      description: |
        __Activity name :__ GetContactsByEmployeeId

        Get list of contacts for an employee
      operationId: GetContactsByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            address:
                              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
                                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: 1234 AA
                                  maxLength: 9
                                  nullable: true
                                  readOnly: false
                                  type: string
                                street:
                                  description: Streetname of the address
                                  example: Voordijk
                                  maxLength: 24
                                  nullable: false
                                  readOnly: false
                                  type: string
                              type: object
                            description:
                              description: Describes the relationship of the contact to the employee
                              example: Moeder
                              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
                            name:
                              description: Name of the contact
                              example: Johanna Bakker
                              maxLength: 70
                              nullable: false
                              readOnly: false
                              type: string
                            particularities:
                              description: Extra information about the contact
                              example: Genoemd adres is een priveadres
                              maxLength: 4000
                              nullable: true
                              readOnly: false
                              type: string
                            phoneNumber:
                              description: The phone number of the contact
                              example: 013-12345678
                              maxLength: 15
                              nullable: true
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 contacts for an employee
      tags:
        - Contact
    post:
      description: |
        __Activity name :__ PostContactByEmployeeId

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ No default values

        Create a new contact for an employee
      operationId: PostContactByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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:
                  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
                    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: 1234 AA
                      maxLength: 9
                      nullable: true
                      readOnly: false
                      type: string
                    street:
                      description: Streetname of the address
                      example: Voordijk
                      maxLength: 24
                      nullable: false
                      readOnly: false
                      type: string
                  type: object
                description:
                  description: Describes the relationship of the contact to the employee
                  example: Moeder
                  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
                name:
                  description: Name of the contact
                  example: Johanna Bakker
                  maxLength: 70
                  nullable: false
                  readOnly: false
                  type: string
                particularities:
                  description: Extra information about the contact
                  example: Genoemd adres is een priveadres
                  maxLength: 4000
                  nullable: true
                  readOnly: false
                  type: string
                phoneNumber:
                  description: The phone number of the contact
                  example: 013-12345678
                  maxLength: 15
                  nullable: true
                  readOnly: false
                  type: string
              type: object
        description: Contact to add to the employee.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          address:
                            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
                              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: 1234 AA
                                maxLength: 9
                                nullable: true
                                readOnly: false
                                type: string
                              street:
                                description: Streetname of the address
                                example: Voordijk
                                maxLength: 24
                                nullable: false
                                readOnly: false
                                type: string
                            type: object
                          description:
                            description: Describes the relationship of the contact to the employee
                            example: Moeder
                            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
                          name:
                            description: Name of the contact
                            example: Johanna Bakker
                            maxLength: 70
                            nullable: false
                            readOnly: false
                            type: string
                          particularities:
                            description: Extra information about the contact
                            example: Genoemd adres is een priveadres
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          phoneNumber:
                            description: The phone number of the contact
                            example: 013-12345678
                            maxLength: 15
                            nullable: true
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 for an employee
      tags:
        - Contact
  "/providers/employers/employees/{employeeId}/customfields":
    get:
      description: |
        __Activity name :__ GetEmployeeCustomFieldsByEmployeeId

        Get a list of the custom fields for an employee.

        __Note:__ custom fields are user defined at the employer level.
      operationId: GetEmployeeCustomFieldssByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            customField:
                              description: |
                                The custom field as defined at the employer-level.  The value can only be set in the POST (it cannot be changed with a PUT).
                              format: metadata
                              nullable: false
                              properties:
                                description:
                                  example: Shoe size
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                                id:
                                  description: The unique identifier of the custom field as defined at the employer level
                                  example: 025ce09b-bff2-4b05-bcf0-711a89da7c08
                                  format: uuid
                                  nullable: false
                                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                  readOnly: false
                                  type: string
                              readOnly: true
                              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
                            value:
                              description: The value for the custom field for the employee
                              example: "41"
                              maxLength: 255
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employee custom fields for an employee
      tags:
        - Employee custom field
    post:
      description: |
        __Activity name :__ PostEmployeeCustomFieldByEmployeeId

        __Metadata:__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.
      operationId: PostEmployeeCustomFieldByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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:
                customField:
                  description: |
                    The custom field as defined at the employer-level.  The value can only be set in the POST (it cannot be changed with a PUT).
                  format: metadata
                  nullable: false
                  properties:
                    description:
                      example: Shoe size
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                    id:
                      description: The unique identifier of the custom field as defined at the employer level
                      example: 025ce09b-bff2-4b05-bcf0-711a89da7c08
                      format: uuid
                      nullable: false
                      pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                      readOnly: false
                      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
                value:
                  description: The value for the custom field for the employee
                  example: "41"
                  maxLength: 255
                  nullable: false
                  readOnly: false
                  type: string
        description: Add a custom field
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          customField:
                            description: |
                              The custom field as defined at the employer-level.  The value can only be set in the POST (it cannot be changed with a PUT).
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Shoe size
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                              id:
                                description: The unique identifier of the custom field as defined at the employer level
                                example: 025ce09b-bff2-4b05-bcf0-711a89da7c08
                                format: uuid
                                nullable: false
                                pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                readOnly: false
                                type: string
                            readOnly: true
                            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
                          value:
                            description: The value for the custom field for the employee
                            example: "41"
                            maxLength: 255
                            nullable: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 an employee custom field for an employee
      tags:
        - Employee custom field
  "/providers/employers/employees/{employeeId}/educations":
    get:
      description: |
        __Activity name :__ GetEducationsByEmployeeId

        Get list of educations for an employee
      operationId: GetEducationsByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            educationLevel:
                              description: Indicates the level of the education.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: HBO
                                  maxLength: 80
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            employeeCosts:
                              description: |
                                The costs of the education for the employee
                              example: 150
                              format: double
                              minimum: 0.01
                              nullable: true
                              readOnly: false
                              type: number
                            employerCosts:
                              description: |
                                The costs of the education for the employer
                              example: 850
                              format: double
                              minimum: 0.01
                              nullable: true
                              readOnly: false
                              type: number
                            endDate:
                              description: The end date of the entity. The date is up to and including.
                              example: 2018-10-23
                              format: date
                              nullable: true
                              readOnly: false
                              type: string
                            endOfValidityDate:
                              description: The end date of the diploma validity . The date is up to and including.
                              example: 2023-12-31
                              format: date
                              nullable: true
                              readOnly: false
                              type: string
                            furtherIndication:
                              format: metadata
                              nullable: true
                              properties:
                                code:
                                  example: WO
                                  nullable: false
                                  readOnly: true
                                  type: string
                                description:
                                  example: Wetenschappelijk
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  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
                              type: object
                            hasDiploma:
                              description: Indicates whether the employee has graduated.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Onbekend
                                  maxLength: 80
                                  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
                            institute:
                              nullable: true
                              properties:
                                Name:
                                  description: Name of the institute
                                  example: Avans Hogeschool
                                  maxLength: 70
                                  nullable: false
                                  readOnly: false
                                  type: string
                                city:
                                  description: City of the institute
                                  example: Leiden
                                  maxLength: 24
                                  nullable: true
                                  readOnly: false
                                  type: string
                              type: object
                            name:
                              description: Name of the education
                              example: HBO accountancy
                              maxLength: 50
                              nullable: false
                              readOnly: false
                              type: string
                            particularities:
                              description: Extra information about the education
                              example: Van de opleiding is alleen een certificaat verkregen
                              maxLength: 4000
                              nullable: true
                              readOnly: false
                              type: string
                            startDate:
                              description: The date on which this education starts.
                              example: 2018-01-01
                              format: date
                              nullable: true
                              readOnly: false
                              type: string
                            typeOfEducation:
                              description: The type of the education. `type of education` is a metadata field within the employer context. Possible values can be managed by the user.
                              format: metadata
                              nullable: true
                              properties:
                                code:
                                  example: WO
                                  nullable: false
                                  readOnly: true
                                  type: string
                                description:
                                  example: Wetenschappelijk
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  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
                              type: object
                            yearOfDiploma:
                              description: Year in which the diploma was aquired
                              example: 1995
                              format: int32
                              maximum: 2099
                              minimum: 1900
                              nullable: true
                              readOnly: false
                              type: integer
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 educations for an employee
      tags:
        - Education
    post:
      description: |
        __Activity name :__ PostEducationByEmployeeId

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ No default values

        Create a new education for an employee
      operationId: PostEducationByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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:
                educationLevel:
                  description: Indicates the level of the education.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: HBO
                      maxLength: 80
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                employeeCosts:
                  description: |
                    The costs of the education for the employee
                  example: 150
                  format: double
                  minimum: 0.01
                  nullable: true
                  readOnly: false
                  type: number
                employerCosts:
                  description: |
                    The costs of the education for the employer
                  example: 850
                  format: double
                  minimum: 0.01
                  nullable: true
                  readOnly: false
                  type: number
                endDate:
                  description: The end date of the entity. The date is up to and including.
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                endOfValidityDate:
                  description: The end date of the diploma validity . The date is up to and including.
                  example: 2023-12-31
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                furtherIndication:
                  format: metadata
                  nullable: true
                  properties:
                    code:
                      example: WO
                      nullable: false
                      readOnly: true
                      type: string
                    description:
                      example: Wetenschappelijk
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      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
                  type: object
                hasDiploma:
                  description: Indicates whether the employee has graduated.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Onbekend
                      maxLength: 80
                      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
                institute:
                  nullable: true
                  properties:
                    Name:
                      description: Name of the institute
                      example: Avans Hogeschool
                      maxLength: 70
                      nullable: false
                      readOnly: false
                      type: string
                    city:
                      description: City of the institute
                      example: Leiden
                      maxLength: 24
                      nullable: true
                      readOnly: false
                      type: string
                  type: object
                name:
                  description: Name of the education
                  example: HBO accountancy
                  maxLength: 50
                  nullable: false
                  readOnly: false
                  type: string
                particularities:
                  description: Extra information about the education
                  example: Van de opleiding is alleen een certificaat verkregen
                  maxLength: 4000
                  nullable: true
                  readOnly: false
                  type: string
                startDate:
                  description: The date on which this education starts.
                  example: 2018-01-01
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                typeOfEducation:
                  description: The type of the education. `type of education` is a metadata field within the employer context. Possible values can be managed by the user.
                  format: metadata
                  nullable: true
                  properties:
                    code:
                      example: WO
                      nullable: false
                      readOnly: true
                      type: string
                    description:
                      example: Wetenschappelijk
                      nullable: false
                      readOnly: true
                      type: string
                    key:
                      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
                  type: object
                yearOfDiploma:
                  description: Year in which the diploma was aquired
                  example: 1995
                  format: int32
                  maximum: 2099
                  minimum: 1900
                  nullable: true
                  readOnly: false
                  type: integer
              type: object
        description: Education to add to the employee.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          educationLevel:
                            description: Indicates the level of the education.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: HBO
                                maxLength: 80
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          employeeCosts:
                            description: |
                              The costs of the education for the employee
                            example: 150
                            format: double
                            minimum: 0.01
                            nullable: true
                            readOnly: false
                            type: number
                          employerCosts:
                            description: |
                              The costs of the education for the employer
                            example: 850
                            format: double
                            minimum: 0.01
                            nullable: true
                            readOnly: false
                            type: number
                          endDate:
                            description: The end date of the entity. The date is up to and including.
                            example: 2018-10-23
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          endOfValidityDate:
                            description: The end date of the diploma validity . The date is up to and including.
                            example: 2023-12-31
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          furtherIndication:
                            format: metadata
                            nullable: true
                            properties:
                              code:
                                example: WO
                                nullable: false
                                readOnly: true
                                type: string
                              description:
                                example: Wetenschappelijk
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                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
                            type: object
                          hasDiploma:
                            description: Indicates whether the employee has graduated.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Onbekend
                                maxLength: 80
                                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
                          institute:
                            nullable: true
                            properties:
                              Name:
                                description: Name of the institute
                                example: Avans Hogeschool
                                maxLength: 70
                                nullable: false
                                readOnly: false
                                type: string
                              city:
                                description: City of the institute
                                example: Leiden
                                maxLength: 24
                                nullable: true
                                readOnly: false
                                type: string
                            type: object
                          name:
                            description: Name of the education
                            example: HBO accountancy
                            maxLength: 50
                            nullable: false
                            readOnly: false
                            type: string
                          particularities:
                            description: Extra information about the education
                            example: Van de opleiding is alleen een certificaat verkregen
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          startDate:
                            description: The date on which this education starts.
                            example: 2018-01-01
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          typeOfEducation:
                            description: The type of the education. `type of education` is a metadata field within the employer context. Possible values can be managed by the user.
                            format: metadata
                            nullable: true
                            properties:
                              code:
                                example: WO
                                nullable: false
                                readOnly: true
                                type: string
                              description:
                                example: Wetenschappelijk
                                nullable: false
                                readOnly: true
                                type: string
                              key:
                                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
                            type: object
                          yearOfDiploma:
                            description: Year in which the diploma was aquired
                            example: 1995
                            format: int32
                            maximum: 2099
                            minimum: 1900
                            nullable: true
                            readOnly: false
                            type: integer
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 education for an employee
      tags:
        - Education
  "/providers/employers/employees/{employeeId}/employments":
    get:
      description: |
        __Activity name :__ GetEmploymentsByEmployeeId

        Get the list of employments for an employee
      operationId: GetEmploymentsByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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=2019-12-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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - properties:
                                employee:
                                  format: metadata
                                  nullable: false
                                  properties:
                                    dateOfBirth:
                                      description: |
                                        The date of birth
                                      example: 1995-05-21
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    employeeNumber:
                                      description: The employee number to uniquely identify a employee within a 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
                                    lastNamePartner:
                                      description: The last name of the partner of the employee
                                      example: Wiel
                                      maxLength: 25
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    photo:
                                      description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                      example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                      format: url
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    prefix:
                                      description: The prefix of the employee
                                      example: van
                                      maxLength: 10
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    prefixPartner:
                                      description: The prefix of the partner of the employee
                                      example: van de
                                      maxLength: 10
                                      nullable: true
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                              type: object
                            - properties:
                                calculateWorkingHours:
                                  description: |
                                    Automatically calculate working hours for the employment if the option automatically calculate hours is selected for a given period. NL: Completeren/Berekenen uren
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                cancellationNoticeDate:
                                  description: "The date on which the notice was given by either the employee or the employer. NL: DatumOpzegging"
                                  example: 2018-05-31
                                  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. NL: OpzegtermijnWerknemer"
                                  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. NL: OpzegtermijnWerkgever"
                                  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. NL: PeriodeOpzegTermijn"
                                  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. NL: AanstellingTot"
                                  example: 2019-01-01
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate1:
                                  description: "Until date for commision #1. NL: AanstellingTot1"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate2:
                                  description: "Until date for commision #2. NL: AanstellingTot2"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate3:
                                  description: "Until date for commision #3. NL: AanstellingTot3"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate4:
                                  description: "Until date for commision #4. NL: AanstellingTot4"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate5:
                                  description: "Until date for commision #5. NL: AanstellingTot5"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate6:
                                  description: "Until date for commision #6. NL: AanstellingTot6"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                deviatingCLAExternalParty:
                                  description: "CLA (CAO) code in case of a deviating CLA for external parties . NL: CaoKlantgroepAfwijkend"
                                  example: 2
                                  format: int32
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                deviatingCLATaxReturn:
                                  description: "CLA (CAO) code in case of a deviating CLA for tax returns. NL: CAOUWV"
                                  example: 2
                                  format: int32
                                  maximum: 9999
                                  minimum: 1
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                emailLeaveRequest:
                                  description: "Recipient e-mail adress for notification in case of leave requests. NL: EmailVerlofaanvraag"
                                  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. NL: WerknemerProfielID

                                    `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
                                employmentCategoryType:
                                  description: "A selection of special pre defined employment-types for the employment.  NL: Type dienstverband"
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    value:
                                      example: Ouderschapsverlof
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                employmentContractType:
                                  description: "The type of employment applicable for the employment. NL: BasisDienstverband"
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Arbeidsovereenkomst (excl BBL)
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                employmentDurationType:
                                  description: "A selection of pre defined durations for the employment. NL: SoortDienstverband"
                                  format: metadata
                                  nullable: false
                                  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
                                endDate:
                                  description: "The date on which the employment ends. NL: DatumUitDienst"
                                  example: 2018-10-23
                                  format: date
                                  nullable: true
                                  readOnly: true
                                  type: string
                                endOfEmploymentDueToIllness:
                                  description: "Indicates whether the reason for the termination of an employment is due to long-term illness. NL: ZiekUitDienst"
                                  example: false
                                  nullable: true
                                  readOnly: true
                                  type: boolean
                                endOfEmploymentReason:
                                  description: |-
                                    The reason for the end of the employment. NL: RedenEindeDienstverband

                                    __Note:__ as of 2020-01-01 `endOfEmploymentReasonTaxAuthorities` replaces this field as the main reason for the end of the employment. We say 'main reason' as in certain cases this field still has a purpose. 
                                    Please set this field to 8 (Others) unless one of the following integrations is used for this employment
                                      * UPA-pensioenaangifte
                                      * Cordares
                                      * APG-pensioenaangifte
                                      * Achmea
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      description: The key for the reason for the end of the employment.
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      description: The description of the reason for the end of the employment.
                                      example: VUT
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                endOfEmploymentReasonTaxAuthorities:
                                  description: |-
                                    The reason for the end of the employment as specified by the Dutch Tax authorties. NL: RedenEindeDienstverbandAangifte

                                    __Note:__ This field replaces `endOfEmploymentReason` as of 2020-01-01. `endOfEmploymentReason` will remain as a field in the resource as several integration require this field still.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      description: The key for the reason for the end of the employment.
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      description: The description of the reason for the end of the employment.
                                      example: Beëindiging arbeidsovereenkomst met wederzijds goedvinden op initiatief van de werkgever.
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                essMutationSet:
                                  description: |-
                                    References to a specified set of payrollcomponents that are to accessible via ESS for employee mutations. Standard-set means the standard set defined for the administration will be applied for this employment. NULL means no set will be defined for this employment (so no access to any components). NL : ExportsetID

                                    `essMutationSet` is a metadata field within the werkgever/provider context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: false
                                  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). NL: CodeUitzondering"
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 0
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Geen uitzondering.
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                exemptionPremiumWaiverMarginalLabour:
                                  description: "Indicates whether an exemption (i.e. waiver) on the premium marginal labour (vrijstelling marginale arbeid) applies for this employment. NL: PremieVrijstellingMarginaleArbeid"
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                exemptionWorkRelatedExpenseScheme:
                                  description: "Indicates whether an exemption (i.e. non-participation) on the work-related expense scheme (werkkostenregeling) applies for this employment. NL: WerkkostenRegelingUitsluiting"
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                firstDayNotification:
                                  description: "Indicates whether a first-day notification (EersteDagsMelding) was created for the employment. Attention: this indication cannot be altered after an employment has been created. NL: EersteDagsMelding "
                                  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. NL: SoortOproepkrachtOfInvalkracht
                                  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. NL: HistorischeDatumInDienst"
                                  example: 2012-05-01
                                  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
                                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. NL: NummerInkomstenVerhouding"
                                  example: 12
                                  format: int32
                                  maximum: 9999
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                isAnonymousEmployee:
                                  description: |
                                    An employee that wants to remain anonymous related to social security instances. NL: IsAnoniemeWerknemer
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                isDirectorAndMajorShareholder:
                                  description: "Indicates whether the employment can be classified as a director and major shareholder (Dutch: directeur-grootaandeelhouder or DGA). This field can be `null` in cases where it is unknown whether the employment can be classified as a director and major shareholder. NL: IsDirecteurGrootAandeelhouder"
                                  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. NL: IsFamilieVanEigenaar"
                                  example: false
                                  nullable: true
                                  readOnly: false
                                  type: boolean
                                isGemoedsbezwaardEmployeeInsurance:
                                  description: |
                                    Gemoedsbezwaard Werknemerverzekering. NL: IsGemoedsbezwaardWerknemerverzekering
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                isGemoedsbezwaardNationalInsurance:
                                  description: |
                                    Gemoedsbezwaard Volksverzekering. NL: IsGemoedsbezwaardVolksverzekering
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                isOnCallEmployment:
                                  description: |
                                    Indicates whether the employment is an on-call employment. This field can be `null` in cases where it is unknown whether the employment is an on-call employment. NL: IsOproepkrachtOfInvalkracht
                                  example: true
                                  nullable: false
                                  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. NL: IsVorigeEigenaar"
                                  example: false
                                  nullable: true
                                  readOnly: false
                                  type: boolean
                                linkedEmployment:
                                  description: The unique identifier of an object (GUID/UUID)
                                  example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                  format: uuid
                                  nullable: true
                                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                  readOnly: true
                                  type: string
                                namePayslip:
                                  description: "Name that is visible on payslips for the employment. NL: NaamLoonstrook"
                                  example: Steve Jobs
                                  maxLength: 34
                                  nullable: true
                                  readOnly: false
                                  type: string
                                nonPayrollAdministration:
                                  description: |-
                                    Id of the non-payroll administration. This field cannot simultaneously have a value with payrollAdministration (only one can have a value at a time)

                                    `nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                                  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: true
                                      type: string
                                    name:
                                      description: Name of the non payroll administration
                                      example: HR only employees
                                      maxLength: 70
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                participation55plusRegulationUWV:
                                  description: "Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment. NL: Deelname55Plus"
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                payrollAdministration:
                                  description: |-
                                    Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time)

                                    `payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                                  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: true
                                      type: string
                                    name:
                                      description: Name of the payroll administration
                                      example: ABC accountants
                                      maxLength: 70
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                payrollId:
                                  description: "The payrolling number for this employment of the employee. Used by the payroll engine. This number is automatically generated and cannot be changed by the user. NL: PersoneelsnummerVerloning"
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                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’. NL: PeriodeSalarisPeriodiek"
                                  example: 2
                                  format: int32
                                  maximum: 52
                                  minimum: 1
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                professionCode:
                                  description: "A code field for a profession. This field only applies in case of a specific CLA (Bouw / Infra). Please leave empty if not applicable. NL: BeroepUWV"
                                  example: 4
                                  format: int32
                                  maximum: 999
                                  minimum: 1
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                sendToExternalParty:
                                  description: "Indicates whether payroll information of this employment is sent to external pension funds. Attention: this indication ONLY applies regarding the information to pension funds. If NULL then setting according to regulation is leading. NL: AanleveringExternePartij"
                                  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
                                signalPayGradeAdjustment:
                                  description: "Indicates whether signaling regarding salary scale adjustments are enabled for the employment. NL: SalarisschaalSignaleren"
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                specialIncomeRatio:
                                  description: "Indicates the special income ratio. NL: SpecialeInkomstenVerhouding"
                                  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. NL: AanvangOpzegtermijn"
                                  example: 2018-06-01
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                startDate:
                                  description: "The date on which this employment starts. NL: DatumInDienst"
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                startDateContractOfIndefiniteDuration:
                                  description: "When did the value of `employmentDurationType` change for definite to indefinite. NL: Startdatum onbepaalde tijd This value should be te samen as the `startDate` if the contract was indefinite from the start."
                                  example: 2018-05-08
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                temporaryTaxExemption:
                                  description: "Indicates whether there a temporary tax exemption is to be applied for the employment. NL: TijdelijkeHeffingskorting"
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Nee.
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                typeOfEmployee:
                                  description: "A selection of pre defined employee-types for the employment. NL: SoortWerknemer"
                                  format: metadata
                                  nullable: false
                                  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 (product required). NL: AardDeelnemerschap"
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 0
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: n.vt.
                                      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. NL: Vakantiebonnen"
                                  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 (product required). NL: WaardeDeelnemerschap"
                                  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
                                wachtgeldOldRegulation:
                                  description: "Indicates whether the (old) wachtgeld regulation is applicable for the employment. NL: WachtgeldOudeRegeling"
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                writtenEmploymentContract:
                                  description: "Did the employment and employer make a written contract? NL: Schriftelijke overeenkomst"
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employments for an employee
      tags:
        - Employment
    post:
      description: |
        __Activity name :__ PostEmploymentByEmployeeId

        Create an additional employment for an already existing employee.

        Please note that the creation of an Employment is not RESTful by design.

        In Loket, when a new Employee is created it will have to be created including its underlying Employment and its accessory resources. This specific endpoint is relevant in the following scenario: there is already an Employee with at least one Employment, and one wishes to create an additional Employment for that currently existing Employee. When successfully calling this endpoint, an Employment with its accessory resources will be created.

        __Metadata :__ 
        * Possible options (metadata) for generic fields of the type "metadata" can be acquired (GET) by adding `/metadata` to the URL.
        * Possible options dependent on a specific payrollAdministration can be acquired by adding `/metadata/payrolladministration/{payrollAdministrationId}` to the url.
        * Possible options for payGrade can be acquired by adding `metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}` to the url.

        A `payGrade` has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request by adding `/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}/paygrade/{payGradeKey}` to the url. This endpoint has the optional parameter "date" that may be used to specifying a measure date.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults` to the URL. 

                
        Default values that are dependent on the selected payroll administration can be acquired by adding `../providers/employers/employees/employments/defaults/payrolladministration/{payrollAdministrationId}` to the URL.

        __NonPayrollAdministrations__ For nonPayrollAdministrations the equivalent metaData-endpoints are also available as described above.  Also, a defaults endpoint is available for the nonPayrollAdministration.  Please note that this requires `../nonpayrolladministrations/{nonPayrollAdministrationId}` in the path.
      operationId: PostEmploymentByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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:
              description: The aggregated employment templates
              nullable: false
              properties:
                employeeData:
                  nullable: false
                  properties:
                    iban:
                      description: International Bank Account Number. Only IBAN without spaces are accepted.
                      example: NL52ABNA0424968264
                      maxLength: 35
                      nullable: true
                      readOnly: false
                      type: string
                  type: object
                employmentData:
                  nullable: false
                  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: 2019-05-31
                      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: 2019-01-01
                      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

                        `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: false
                      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: false
                      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

                        `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: false
                      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: false
                      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: 2012-05-01
                      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: false
                      readOnly: false
                      type: integer
                    isAnonymousEmployee:
                      description: "Indicates whether employee is anonymous "
                      example: true
                      nullable: false
                      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: false
                      readOnly: false
                      type: boolean
                    isOnCallEmployment:
                      description: Indicates whether the employment is an on-call employment.
                      example: true
                      nullable: false
                      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`

                        `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: false
                      readOnly: false
                      type: boolean
                    payrollAdministration:
                      description: |-
                        An administration used for payrolling. This field can not have a value at the same time as `nonPayrollAdministration`

                        `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 payroll 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: false
                      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: 2019-06-01
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    startDate:
                      description: The date on which this employment starts.
                      example: 2019-01-01
                      format: date
                      nullable: false
                      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: 2018-05-08
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    typeOfEmployee:
                      description: A selection of pre defined employee-types for the employment.
                      format: metadata
                      nullable: false
                      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.vt.
                          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: false
                      readOnly: false
                      type: boolean
                  type: object
                fiscalData:
                  nullable: false
                  properties:
                    annualSalary:
                      description: The fiscal annual salary
                      example: 60000
                      format: double
                      maximum: 1000000000
                      minimum: 0
                      nullable: false
                      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: false
                      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: false
                      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: false
                      type: number
                    deviatingPayrollTaxTableColour:
                      description: Indicates if there is a deviating payroll tax table is applicable (green vs white table)
                      format: metadata
                      nullable: false
                      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.
                      format: metadata
                      nullable: false
                      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
                organizationalEntityData:
                  nullable: false
                  properties:
                    department:
                      description: |-
                        The department of the employment.

                        `department` is a metadata field within the employer context. Possible values can be managed by the user.
                      format: metadata
                      nullable: false
                      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. 

                        `distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user. 
                      format: metadata
                      nullable: false
                      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.

                        `function` is a metadata field within the employer context. Possible values can be managed by the user.
                      format: metadata
                      nullable: false
                      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)
                          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.

                        `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: false
                  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
                socialSecurityData:
                  nullable: false
                  properties:
                    healthCareInsuranceActType:
                      description: Indicates what type of Health Care Insurance Act (Zvw) is applicable for this employment
                      format: metadata
                      nullable: false
                      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: false
                      readOnly: false
                      type: boolean
                    isInsuredForSicknessBenefitsAct:
                      description: Will contributions for the  Sickness Benefits Act (ZW) be payed for this employment
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                    isInsuredForUnemploymentInsuranceAct:
                      description: Will contributions for the  Unemployment Insurance Act (WW) be payed for this employment
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                  type: object
                wageData:
                  nullable: false
                  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. 
                      example: true
                      nullable: true
                      readOnly: false
                      type: boolean
                    grossWage:
                      description: |
                        The gross wage for the employee
                      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.
                      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
                      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.
                      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. 

                        `payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                      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.

                        `payScale` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                      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: false
                  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: false
                          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: false
                          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: false
                          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: false
                          readOnly: false
                          type: boolean
                        leaveHours:
                          description: Indicates whether then leave balances (verlof) are to be calculated based on the workpattern.
                          example: true
                          nullable: false
                          readOnly: false
                          type: boolean
                      type: object
                    contractCode:
                      description: |-
                        This field is specialy made for convenience stores. The field is the type of contract.

                        `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)
                          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: false
                      readOnly: false
                      type: boolean
                    shift:
                      description: |-
                        The shift determines the full-time hours and bonus percentage.

                        `shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                      format: metadata
                      nullable: false
                      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. <br /> Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                      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
              readOnly: false
              type: object
        description: The request body contains an object for the additional employment.
        required: true
      responses:
        "201":
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - 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
                    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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employment for existing employee
      tags:
        - Create employment
  "/providers/employers/employees/{employeeId}/notes":
    get:
      description: |
        __Activity name :__ GetEmployeeNotesByEmployeeId

        Get a list of notes, available for the user, for the employee. 
      operationId: GetEmployeeNotesByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            accessibleBy:
                              description: |
                                Indicates who can view this node.
                              nullable: false
                              properties:
                                key:
                                  description: The key for accessible by
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: Description of the accessible by
                                  example: Everyone
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            createdBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            createdOn:
                              description: |
                                The date on which the note was created
                              example: 2018-01-01
                              format: date-time
                              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
                            lastModifiedBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            lastModifiedOn:
                              description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                              example: 2018-01-01
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            note:
                              description: |-
                                The note it self.

                                __Note:__ This is a free text field so users can add htlm/script etc.
                              example: Remember to do xyz
                              maxLength: 4000
                              nullable: true
                              readOnly: false
                              type: string
                            subject:
                              description: subject of the note
                              example: Remember to do xyz
                              maxLength: 250
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 notes for an employee.
      tags:
        - Employee notes
    post:
      description: |
        __Activity name :__ PostEmployeeNoteByEmployeeId

        __Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.

        __Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostEmployeeNoteByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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:
                accessibleBy:
                  description: |
                    Indicates who can view this node.
                  nullable: false
                  properties:
                    key:
                      description: The key for accessible by
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: Description of the accessible by
                      example: Everyone
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                createdBy:
                  format: metadata
                  nullable: true
                  properties:
                    formattedName:
                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                createdOn:
                  description: |
                    The date on which the note was created
                  example: 2018-01-01
                  format: date-time
                  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
                lastModifiedBy:
                  format: metadata
                  nullable: true
                  properties:
                    formattedName:
                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                lastModifiedOn:
                  description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                  example: 2018-01-01
                  format: date-time
                  nullable: false
                  readOnly: true
                  type: string
                note:
                  description: |-
                    The note it self.

                    __Note:__ This is a free text field so users can add htlm/script etc.
                  example: Remember to do xyz
                  maxLength: 4000
                  nullable: true
                  readOnly: false
                  type: string
                subject:
                  description: subject of the note
                  example: Remember to do xyz
                  maxLength: 250
                  nullable: false
                  readOnly: false
                  type: string
              type: object
        description: Add a note
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          accessibleBy:
                            description: |
                              Indicates who can view this node.
                            nullable: false
                            properties:
                              key:
                                description: The key for accessible by
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: Description of the accessible by
                                example: Everyone
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          createdBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          createdOn:
                            description: |
                              The date on which the note was created
                            example: 2018-01-01
                            format: date-time
                            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
                          lastModifiedBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          lastModifiedOn:
                            description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                            example: 2018-01-01
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          note:
                            description: |-
                              The note it self.

                              __Note:__ This is a free text field so users can add htlm/script etc.
                            example: Remember to do xyz
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          subject:
                            description: subject of the note
                            example: Remember to do xyz
                            maxLength: 250
                            nullable: false
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 note for an employee
      tags:
        - Employee notes
  "/providers/employers/employees/{employeeId}/occupationaldisabilities":
    get:
      description: |
        __Activity name :__ GetOccupationalDisabilitiesByEmployeeId

        Get the list of occupational disabilities for an employee. This endpoint returns occupational disability information regarding the Occupational Disability Insurance Act (WAO) and Work Capacity Act (WIA).
      operationId: GetOccupationalDisabilitiesByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            classification:
                              description: The occupational disability classification in the form of a percentage range.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  description: |
                                    The key of the occupational disability classification. Possible values can be acquired via the metadata endpoint.
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  description: |
                                    Description of the occupational disability classification.
                                  example: 15 - 24
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            endDate:
                              description: end date
                              example: 2018-01-21
                              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
                            isExWAO:
                              description: Indicates whether the employee has received WAO payments before.
                              example: true
                              nullable: true
                              readOnly: false
                              type: boolean
                            isOccupationallyDisabled:
                              description: Indicates whether the employee is incapacitated.
                              example: false
                              nullable: true
                              readOnly: false
                              type: boolean
                            startDate:
                              description: |-
                                The startdate of the record

                                A (broken chain)[./#section/Data/Date-chains] is maintained within this resource.
                              example: 2017-05-21
                              format: date
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 occupational disabilities for an employee
      tags:
        - Occupational disability
  "/providers/employers/employees/{employeeId}/partners":
    get:
      description: |
        __Activity name :__ GetPartnersByEmployeeId

        Get the list of partners of the employee
      operationId: GetPartnersByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            dateOfBirth:
                              description: |
                                The date of birth
                              example: 1995-05-21
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            dateOfDeath:
                              description: |
                                The date of death
                              format: date
                              nullable: true
                              readOnly: false
                              type: string
                            endDate:
                              description: end date
                              example: 1995-05-21
                              format: date
                              nullable: true
                              readOnly: false
                              type: string
                            firstName:
                              description: |
                                The first name, given name, forename or Christian name as part of a persons personal name.
                              example: Susan
                              maxLength: 28
                              minLength: 1
                              nullable: true
                              readOnly: false
                              type: string
                            gender:
                              description: |
                                The gender
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: female
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              type: object
                            howToFormatLastName:
                              description: |
                                Indicates how the system will format the last name.
                              format: metadata
                              nullable: false
                              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
                              readOnly: false
                              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
                            initials:
                              description: |
                                The initials
                              example: S.L.
                              maxLength: 6
                              minLength: 1
                              nullable: true
                              readOnly: false
                              type: string
                            lastName:
                              description: |
                                The last name, family name or surname as part of a persons personal name.
                              example: Bergen
                              maxLength: 25
                              minLength: 1
                              nullable: false
                              readOnly: false
                              type: string
                            placeOfBirth:
                              description: |
                                The place of birth
                              example: Amsterdam
                              maxLength: 24
                              minLength: 1
                              nullable: true
                              readOnly: false
                              type: string
                            prefix:
                              description: |
                                The prefix to the last name
                              example: van
                              maxLength: 10
                              minLength: 1
                              nullable: true
                              readOnly: false
                              type: string
                            startDate:
                              description: startdate
                              example: 1995-05-21
                              format: date
                              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
                              readOnly: false
                              type: object
                            waoClassification:
                              description: The occupational disability classification in the form of a percentage range.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  description: |
                                    The key of the occupational disability classification. Possible values can be acquired via the metadata endpoint.
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    Description of the occupational disability classification.
                                  example: 15 - 24
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 partners for an employee
      tags:
        - Partner
    post:
      description: |
        __Activity name :__ PostPartnerByEmployeeId

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__  Default values for a new object can be acquired by adding `/defaults' to the POST URL. 

        Create the partner for an employee
      operationId: PostPartnerByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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:
                dateOfBirth:
                  description: |
                    The date of birth
                  example: 1995-05-21
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                dateOfDeath:
                  description: |
                    The date of death
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                endDate:
                  description: end date
                  example: 1995-05-21
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                firstName:
                  description: |
                    The first name, given name, forename or Christian name as part of a persons personal name.
                  example: Susan
                  maxLength: 28
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                gender:
                  description: |
                    The gender
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: female
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
                howToFormatLastName:
                  description: |
                    Indicates how the system will format the last name.
                  format: metadata
                  nullable: false
                  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
                  readOnly: false
                  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
                initials:
                  description: |
                    The initials
                  example: S.L.
                  maxLength: 6
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                lastName:
                  description: |
                    The last name, family name or surname as part of a persons personal name.
                  example: Bergen
                  maxLength: 25
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                placeOfBirth:
                  description: |
                    The place of birth
                  example: Amsterdam
                  maxLength: 24
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                prefix:
                  description: |
                    The prefix to the last name
                  example: van
                  maxLength: 10
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                startDate:
                  description: startdate
                  example: 1995-05-21
                  format: date
                  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
                  readOnly: false
                  type: object
                waoClassification:
                  description: The occupational disability classification in the form of a percentage range.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      description: |
                        The key of the occupational disability classification. Possible values can be acquired via the metadata endpoint.
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        Description of the occupational disability classification.
                      example: 15 - 24
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
              type: object
        description: Partner to add to the employee.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          dateOfBirth:
                            description: |
                              The date of birth
                            example: 1995-05-21
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          dateOfDeath:
                            description: |
                              The date of death
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          endDate:
                            description: end date
                            example: 1995-05-21
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          firstName:
                            description: |
                              The first name, given name, forename or Christian name as part of a persons personal name.
                            example: Susan
                            maxLength: 28
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          gender:
                            description: |
                              The gender
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: female
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          howToFormatLastName:
                            description: |
                              Indicates how the system will format the last name.
                            format: metadata
                            nullable: false
                            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
                            readOnly: false
                            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
                          initials:
                            description: |
                              The initials
                            example: S.L.
                            maxLength: 6
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          lastName:
                            description: |
                              The last name, family name or surname as part of a persons personal name.
                            example: Bergen
                            maxLength: 25
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          placeOfBirth:
                            description: |
                              The place of birth
                            example: Amsterdam
                            maxLength: 24
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          prefix:
                            description: |
                              The prefix to the last name
                            example: van
                            maxLength: 10
                            minLength: 1
                            nullable: true
                            readOnly: false
                            type: string
                          startDate:
                            description: startdate
                            example: 1995-05-21
                            format: date
                            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
                            readOnly: false
                            type: object
                          waoClassification:
                            description: The occupational disability classification in the form of a percentage range.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                description: |
                                  The key of the occupational disability classification. Possible values can be acquired via the metadata endpoint.
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  Description of the occupational disability classification.
                                example: 15 - 24
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the partner for an employee
      tags:
        - Partner
  "/providers/employers/employees/{employeeId}/photo":
    delete:
      description: |
        __Activity name :__ DeleteEmployeePhotoByEmployeeId

        Photo of the employee to use as an avatar/profile picture
      operationId: DeleteEmployeePhotoByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employee photo
      tags:
        - Employee
    get:
      description: |
        __Activity name :__ GetEmployeePhotoByEmployeeId

        Photo of the employee to use as an avatar/profile picture

        __Caching:__ This resource changes very infrequently and can be cached for a longer time.
      operationId: GetEmployeePhotoByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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: Photo of an employee
      tags:
        - Employee
    post:
      description: |
        __Activity name :__ PostEmployeePhotoByEmployeeId

        Photo of the employee to use as an avatar/profile picture
      operationId: PostEmployeePhotoByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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:
                data:
                  description: base64 encoded document file.
                  example: YQ==
                  nullable: false
                  readOnly: false
                  type: string
                mimeType:
                  description: The mimetype of the data.
                  example: image/jpeg
                  nullable: false
                  readOnly: false
                  type: string
        description: Logo to be uploaded for the employer.
        required: true
      responses:
        "200":
          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: Post employee photo
      tags:
        - Employee
  "/providers/employers/employees/{employeeId}/photo/{version}":
    get:
      description: |
        __Activity name :__ GetEmployeePhotoByEmployeeIdAndVersion

        Photo of the employee to use as an avatar/profile picture

        __Caching:__ This resource changes very infrequently and can be cached for a longer time.
      operationId: GetEmployeePhotoByEmployeeIdAndVersion
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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: An optional guid generated for caching. The value does not influence the output of this function. The Employee resource returns the URI of the current photo.
          in: path
          name: version
          required: true
          schema:
            format: uuid
            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: Photo of an employee
      tags:
        - Employee
  "/providers/employers/employees/{employeeId}/revokeEmployeeSelfServiceAccess":
    patch:
      description: |
        __Activity name :__ PatchRevokeEmployeeSelfServiceAccessByEmployeeId

        This endpoint allows the user to set the 'revokeEmployeeSelfServiceAccessOn'. This date indicates on what day the access to WerknemerLoket (Employee Self Service) will be revoked (this is done by scheduled tasks that run during the night). This is particularly useful for situations where for example the employer wants to restrict access at a specific date in the future, for example 1st of May in the next year.

        The value may be set to NULL and thus clearing the date on which access would be revoked. Please note that this endpoint will not automatically 'unblock' an Employee, as that would require a specific action.
      operationId: PatchRevokeEmployeeSelfServiceAccessByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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:
                revokeEmployeeSelfServiceAccessOn:
                  description: |
                    The date on which the Employees access to ESS (werknemer.loket) will be automatically revoked.
                  example: 2018-10-23
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
        description: The request body contains an object containing fields related to termination of an employment.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Set the date on which to revoke ESS access
      tags:
        - Employee
  "/providers/employers/employees/{employeeId}/selfservice":
    get:
      description: |
        __Activity name :__ GetEmployeeSelfServiceByEmployeeId

        Get the details of an employee with regards to ESS access
      operationId: GetEmployeeSelfServiceByEmployeeId
      parameters:
        - description: The unique identifier of the employee
          in: path
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          employee:
                            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
                          hasTwoFactorAuthentication:
                            description: Does the employee have two factor authentication enabled
                            example: false
                            nullable: false
                            readOnly: true
                            type: boolean
                          status:
                            description: Description of the status
                            enum:
                              - HasAccessToClient
                              - NoAccessToClient
                              - UserIsBlocked
                              - AccessToClientIsBlocked
                              - InvitePending
                              - InviteFailed
                              - InviteCancelled
                              - InviteExpired
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 and employees self service portal status
      tags:
        - Employee self service
  "/providers/employers/functions/{functionId}":
    get:
      description: |
        __Activity name:__ GetFunctionByFunctionId

        Get the details of function
      operationId: GetFunctionByFunctionId
      parameters:
        - description: The unique identifier of the function
          in: path
          name: functionId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          description:
                            example: Directeur
                            maxLength: 50
                            nullable: false
                            readOnly: false
                            type: string
                          group:
                            example: Var
                            maxLength: 5
                            nullable: true
                            readOnly: false
                            type: string
                          key:
                            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
          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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 function
      tags:
        - Functions
    put:
      description: |
        __Activity name:__ PutFunctionByFunctionId

        Edit the details for a function

        __Metadata:__ No metadata
      operationId: PutFunctionByFunctionId
      parameters:
        - description: The unique identifier of the function
          in: path
          name: functionId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                description:
                  example: Directeur
                  maxLength: 50
                  nullable: false
                  readOnly: false
                  type: string
                group:
                  example: Var
                  maxLength: 5
                  nullable: true
                  readOnly: false
                  type: string
                key:
                  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
        description: Function 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          description:
                            example: Directeur
                            maxLength: 50
                            nullable: false
                            readOnly: false
                            type: string
                          group:
                            example: Var
                            maxLength: 5
                            nullable: true
                            readOnly: false
                            type: string
                          key:
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a function
      tags:
        - Functions
  /providers/employers/lastmodifiedversionnumbers:
    get:
      description: |
        __Activity name :__ GetEmployerLastModifiedVersionNumbersByUser

        **What does the 'last modified' version number reflect**

        The sequence number of an employer is a sequential number that reflects whether any changes have occurred in any of its UNDERLYING employments.

        More precisely, it reflects the sequence number after the latest change of any database record that relates to an employment within this employer.   What we consider to be 'underlying' employment data is based on a predefined set of tables, and of course given id.  This predefined set of tables can be found [here](../TablesLastModifiedVersionNumber.xlsx)

        The scope of this predefined set is to represent 'static' employment data (vaste gegevens), and thus excludes payroll period data (variabele gegevens).

        **When to use**

        This endpoint is most useful for integrations that regularly synchronize Loket employment data with another system.  As there are no webhooks available, in practice these integrations would need to regularly poll all data to see whether there any changes in the employment data.  The most elementary approach of getting all employment data every time you sync acquires a LOT of calls, in some cases even millions per day.  Even though we can handle quite a lot, this is not always the desired way for both client and server. Hence, this endpoint enables an alternative solution to set up such an integration.

        **How to use**

        With every update (including additions and deletions) the version number will increase. I.e. the version number will NEVER decrease over time.  (Please note this is not only true within the context of a single employer (or any other entity) but applies to all changes in the database).
        Consequently, in practice one would use this endpoint to check if any empLoyer version numbers have increased by applying the filter query parameter to the version field, for example `?filter=version gt 70429274`.

        *Recommended usage*

        * Perform your regular synchronization of static employment data
        * Store the highest version number, for which you have now processed all changes. (You may use the following parameter to do this `?orderBy=-lastModifiedVersionNumber` )
        * Next time you want to perform synchronization. Call this endpoint with parameter `?filter=lastModifiedVersionNumber gt {{YourVersionNumber}}`
        * Only get employment information for employers that are included in that filtered list. (exclude all other employers as you already know there have been no changes since the last synchronization)
      operationId: GetEmployerLastModifiedVersionNumbersByUser
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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
                            lastModifiedVersionNumber:
                              description: The version number reflects the latest version of all predefined underlying tables of this employer/employment.
                              example: 70429274999853
                              format: int64
                              nullable: false
                              readOnly: true
                              type: integer
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employer last modified version numbers
      tags:
        - Last modified version numbers
  "/providers/employers/leavePolicies/agebasedleave/{ageBasedLeaveId}":
    delete:
      description: |
        __Activity name :__ DeleteAgeBasedLeaveByAgeBasedLeaveId

        Delete an age based leave record
      operationId: DeleteAgeBasedLeaveByAgeBasedLeaveId
      parameters:
        - description: The unique identifier of the age based leave
          in: path
          name: ageBasedLeaveId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 age based leave record
      tags:
        - Leave policy
    get:
      description: |-
        __Activity name :__ GetAgeBasedLeaveByAgeBasedLeaveId

        Returns one leave age based leave record
      operationId: GetAgeBasedLeaveByAgeBasedLeaveId
      parameters:
        - description: The unique identifier of the age based leave
          in: path
          name: ageBasedLeaveId
          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 <TOKEN>
            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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          from:
                            nullable: false
                            properties:
                              numberOfMonths:
                                description: the number of months of age to be applicable for the additional leave
                                example: 0
                                format: int32
                                maximum: 11
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                              numberOfYears:
                                description: the employee's minimal age to be applicable for the additional leave
                                example: 40
                                format: int32
                                maximum: 999
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                            readOnly: false
                            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
                          leaveEntitlement:
                            nullable: false
                            properties:
                              excessLeaveToStatutory:
                                description: |-
                                  The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.

                                  Either excessLeaveToStatutory or wtr must have a value
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                              wtr:
                                description: |-
                                  The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                                

                                  Either excessLeaveToStatutory or wtr must have a value                
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          upToAndIncluding:
                            properties:
                              numberOfMonths:
                                description: the number of months of age to be applicable for the additional leave
                                example: 11
                                format: int32
                                maximum: 11
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                              numberOfYears:
                                description: the employee's minimal age to be applicable for the additional leave
                                example: 50
                                format: int32
                                maximum: 999
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: An age based leave record
      tags:
        - Leave policy
    put:
      description: |
        __Activity name :__ PutAgeBasedLeaveByAgeBasedLeaveId

        Edit the details of an age based leave record
      operationId: PutAgeBasedLeaveByAgeBasedLeaveId
      parameters:
        - description: The unique identifier of the age based leave
          in: path
          name: ageBasedLeaveId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                from:
                  nullable: false
                  properties:
                    numberOfMonths:
                      description: the number of months of age to be applicable for the additional leave
                      example: 0
                      format: int32
                      maximum: 11
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                    numberOfYears:
                      description: the employee's minimal age to be applicable for the additional leave
                      example: 40
                      format: int32
                      maximum: 999
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                  readOnly: false
                  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
                leaveEntitlement:
                  nullable: false
                  properties:
                    excessLeaveToStatutory:
                      description: |-
                        The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.

                        Either excessLeaveToStatutory or wtr must have a value
                      example: 40
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,3})(.\d{1,2})?$
                      readOnly: false
                      type: number
                    wtr:
                      description: |-
                        The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                      

                        Either excessLeaveToStatutory or wtr must have a value                
                      example: 40
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,3})(.\d{1,2})?$
                      readOnly: false
                      type: number
                  readOnly: false
                  type: object
                upToAndIncluding:
                  properties:
                    numberOfMonths:
                      description: the number of months of age to be applicable for the additional leave
                      example: 11
                      format: int32
                      maximum: 11
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                    numberOfYears:
                      description: the employee's minimal age to be applicable for the additional leave
                      example: 50
                      format: int32
                      maximum: 999
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
        description: age based leave 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          from:
                            nullable: false
                            properties:
                              numberOfMonths:
                                description: the number of months of age to be applicable for the additional leave
                                example: 0
                                format: int32
                                maximum: 11
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                              numberOfYears:
                                description: the employee's minimal age to be applicable for the additional leave
                                example: 40
                                format: int32
                                maximum: 999
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                            readOnly: false
                            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
                          leaveEntitlement:
                            nullable: false
                            properties:
                              excessLeaveToStatutory:
                                description: |-
                                  The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.

                                  Either excessLeaveToStatutory or wtr must have a value
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                              wtr:
                                description: |-
                                  The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                                

                                  Either excessLeaveToStatutory or wtr must have a value                
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          upToAndIncluding:
                            properties:
                              numberOfMonths:
                                description: the number of months of age to be applicable for the additional leave
                                example: 11
                                format: int32
                                maximum: 11
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                              numberOfYears:
                                description: the employee's minimal age to be applicable for the additional leave
                                example: 50
                                format: int32
                                maximum: 999
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of an age based leave
      tags:
        - Leave policy
  "/providers/employers/leavePolicies/wagebasedleave/{wageBasedLeaveId}":
    delete:
      description: |
        __Activity name :__ DeleteWageBasedLeaveByWageBasedLeaveId

        Delete a wage based leave record
      operationId: DeleteWageBasedLeaveByWageBasedLeaveId
      parameters:
        - description: The unique identifier of the wage based leave
          in: path
          name: wageBasedLeaveId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 wage based leave record
      tags:
        - Leave policy
    get:
      description: |-
        __Activity name :__ GetWageBasedLeaveByAgeBasedLeaveId

        Returns one leave wage based leave record
      operationId: GetWageBasedLeaveByWageBasedLeaveId
      parameters:
        - description: The unique identifier of the wage based leave
          in: path
          name: wageBasedLeaveId
          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 <TOKEN>
            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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          fromWage:
                            description: the from wage the employment has to earn to be applicable for the additional leave
                            example: 40
                            format: double
                            maximum: 99999999999999.98
                            minimum: 0
                            nullable: false
                            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
                          leaveEntitlement:
                            nullable: false
                            properties:
                              excessLeaveToStatutory:
                                description: |-
                                  The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.
                                                

                                  Either excessLeaveToStatutory or wtr must have a value
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,14})(.\d{1,2})?$
                                readOnly: false
                                type: number
                              wtr:
                                description: |-
                                  The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                                

                                  Either excessLeaveToStatutory or wtr must have a value
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          upToAndIncludingWage:
                            description: the up to and including wage the employment has to earn to be applicable for the additional leave
                            example: 40
                            format: double
                            maximum: 99999999999999.98
                            minimum: 0
                            nullable: false
                            readOnly: false
                            type: number
                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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: A wage based leave record
      tags:
        - Leave policy
    put:
      description: |
        __Activity name :__ PutWageBasedLeaveByWageBasedLeaveId

        Edit the details of a wage based leave record
      operationId: PutWageBasedLeaveByWageBasedLeaveId
      parameters:
        - description: The unique identifier of the wage based leave
          in: path
          name: wageBasedLeaveId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                fromWage:
                  description: the from wage the employment has to earn to be applicable for the additional leave
                  example: 40
                  format: double
                  maximum: 99999999999999.98
                  minimum: 0
                  nullable: false
                  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
                leaveEntitlement:
                  nullable: false
                  properties:
                    excessLeaveToStatutory:
                      description: |-
                        The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.
                                      

                        Either excessLeaveToStatutory or wtr must have a value
                      example: 40
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,14})(.\d{1,2})?$
                      readOnly: false
                      type: number
                    wtr:
                      description: |-
                        The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                      

                        Either excessLeaveToStatutory or wtr must have a value
                      example: 40
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,3})(.\d{1,2})?$
                      readOnly: false
                      type: number
                  readOnly: false
                  type: object
                upToAndIncludingWage:
                  description: the up to and including wage the employment has to earn to be applicable for the additional leave
                  example: 40
                  format: double
                  maximum: 99999999999999.98
                  minimum: 0
                  nullable: false
                  readOnly: false
                  type: number
        description: wage based leave 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          fromWage:
                            description: the from wage the employment has to earn to be applicable for the additional leave
                            example: 40
                            format: double
                            maximum: 99999999999999.98
                            minimum: 0
                            nullable: false
                            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
                          leaveEntitlement:
                            nullable: false
                            properties:
                              excessLeaveToStatutory:
                                description: |-
                                  The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.
                                                

                                  Either excessLeaveToStatutory or wtr must have a value
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,14})(.\d{1,2})?$
                                readOnly: false
                                type: number
                              wtr:
                                description: |-
                                  The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                                

                                  Either excessLeaveToStatutory or wtr must have a value
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          upToAndIncludingWage:
                            description: the up to and including wage the employment has to earn to be applicable for the additional leave
                            example: 40
                            format: double
                            maximum: 99999999999999.98
                            minimum: 0
                            nullable: false
                            readOnly: false
                            type: number
                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a wage based leave
      tags:
        - Leave policy
  "/providers/employers/leavePolicies/yearsofservicebasedleave/{yearsOfServiceBasedLeaveId}":
    delete:
      description: |
        __Activity name :__ DeleteYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId

        Delete an years of service based leave record
      operationId: DeleteYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId
      parameters:
        - description: The unique identifier of the years of service based leave
          in: path
          name: yearsOfServiceBasedLeaveId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 years of service based leave record
      tags:
        - Leave policy
    get:
      description: |-
        __Activity name :__ GetYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId

        Returns one leave years of service based leave record
      operationId: GetYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId
      parameters:
        - description: The unique identifier of the years of service based leave
          in: path
          name: yearsOfServiceBasedLeaveId
          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 <TOKEN>
            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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          from:
                            properties:
                              numberOfMonths:
                                description: the number of months of service to be applicable for the additional leave
                                example: 0
                                format: int32
                                maximum: 11
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                              numberOfYears:
                                description: the number of years of service to be applicable for the additional leave
                                example: 40
                                format: int32
                                maximum: 999
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                            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
                          leaveEntitlement:
                            nullable: false
                            properties:
                              excessLeaveToStatutory:
                                description: |-
                                  The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.

                                  Either excessLeaveToStatutory or wtr must have a value
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                              wtr:
                                description: |-
                                  The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.

                                  Either excessLeaveToStatutory or wtr must have a value
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          upToAndIncluding:
                            properties:
                              numberOfMonths:
                                description: the number of months of service to be applicable for the additional leave
                                example: 0
                                format: int32
                                maximum: 11
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                              numberOfYears:
                                description: the number of years of service to be applicable for the additional leave
                                example: 40
                                format: int32
                                maximum: 999
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: A years of service based leave record
      tags:
        - Leave policy
    put:
      description: |
        __Activity name :__ PutYearsOFServiceBasedLeaveByYearsOfServiceBasedLeaveId

        Edit the details of a years of service based leave record
      operationId: PutYearsOFServiceBasedLeaveByYearsOfServiceBasedLeaveId
      parameters:
        - description: The unique identifier of the years of service based leave
          in: path
          name: yearsOfServiceBasedLeaveId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                from:
                  properties:
                    numberOfMonths:
                      description: the number of months of service to be applicable for the additional leave
                      example: 0
                      format: int32
                      maximum: 11
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                    numberOfYears:
                      description: the number of years of service to be applicable for the additional leave
                      example: 40
                      format: int32
                      maximum: 999
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                  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
                leaveEntitlement:
                  nullable: false
                  properties:
                    excessLeaveToStatutory:
                      description: |-
                        The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.

                        Either excessLeaveToStatutory or wtr must have a value
                      example: 40
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,3})(.\d{1,2})?$
                      readOnly: false
                      type: number
                    wtr:
                      description: |-
                        The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.

                        Either excessLeaveToStatutory or wtr must have a value
                      example: 40
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,3})(.\d{1,2})?$
                      readOnly: false
                      type: number
                  readOnly: false
                  type: object
                upToAndIncluding:
                  properties:
                    numberOfMonths:
                      description: the number of months of service to be applicable for the additional leave
                      example: 0
                      format: int32
                      maximum: 11
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                    numberOfYears:
                      description: the number of years of service to be applicable for the additional leave
                      example: 40
                      format: int32
                      maximum: 999
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
        description: years of service based leave 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          from:
                            properties:
                              numberOfMonths:
                                description: the number of months of service to be applicable for the additional leave
                                example: 0
                                format: int32
                                maximum: 11
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                              numberOfYears:
                                description: the number of years of service to be applicable for the additional leave
                                example: 40
                                format: int32
                                maximum: 999
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                            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
                          leaveEntitlement:
                            nullable: false
                            properties:
                              excessLeaveToStatutory:
                                description: |-
                                  The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.

                                  Either excessLeaveToStatutory or wtr must have a value
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                              wtr:
                                description: |-
                                  The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.

                                  Either excessLeaveToStatutory or wtr must have a value
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          upToAndIncluding:
                            properties:
                              numberOfMonths:
                                description: the number of months of service to be applicable for the additional leave
                                example: 0
                                format: int32
                                maximum: 11
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                              numberOfYears:
                                description: the number of years of service to be applicable for the additional leave
                                example: 40
                                format: int32
                                maximum: 999
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a years of service based leave
      tags:
        - Leave policy
  "/providers/employers/leavePolicies/{leavePolicyId}":
    delete:
      description: |
        __Activity name :__ DeleteLeavePolicyByLeavePolicyId

        Delete a Leave policy
      operationId: DeleteLeavePolicyByLeavePolicyId
      parameters:
        - description: The unique identifier of the leave policy
          in: path
          name: leavePolicyId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 leave policy
      tags:
        - Leave policy
    get:
      description: |-
        __Activity name :__ GetLeavePolicyByLeavePolicyId

        Returns one leave policy
      operationId: GetLeavePolicyByLeavePolicyId
      parameters:
        - description: The unique identifier of the leave policy
          in: path
          name: leavePolicyId
          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 <TOKEN>
            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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          accrualType:
                            description: "Indicates how leave is accrued (yearly, monthly or hourly)  "
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The key for the `accrualType`
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the `accrualType`
                                example: Jaar
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          additionalLeave:
                            nullable: false
                            properties:
                              allocationType:
                                description: Indicates how additional leave is to be assigned to the employments (linked to this leave policy).
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The key for the `additionalLeaveAllocationType`
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: |
                                      The description for the `additionalLeaveAllocationType`
                                    example: Boek alleen hoogste waarde
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: false
                                type: object
                              referenceDate1:
                                description: If `referenceDate2` has a value only the last 6 months of the year are allowed as values
                                nullable: false
                                properties:
                                  day:
                                    description: The day of the first reference date.
                                    example: 40
                                    format: int32
                                    maximum: 31
                                    minimum: 1
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  month:
                                    description: "The month of the first reference date "
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        description: |
                                          The key for the `referenceMonth`
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        description: |
                                          The description for the `referenceMonth`
                                        example: Januari
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    readOnly: false
                                    type: object
                                type: object
                              referenceDate2:
                                description: Only use if applicable
                                nullable: true
                                properties:
                                  day:
                                    description: The day of the second reference date.
                                    example: 40
                                    format: int32
                                    maximum: 31
                                    minimum: 1
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  month:
                                    description: "The month of the second reference date "
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        description: |
                                          The key for the `referenceMonth`
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        description: |
                                          The description for the `referenceMonth`
                                        example: Januari
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    readOnly: false
                                    type: object
                                type: object
                            readOnly: false
                            type: object
                          dayOfTheMonthToPerformAutomaticLeaveCalculationOn:
                            description: |-
                              They day of the month on which the automatic accrual of (yearly or monthly) leave is performed. The yearly calculation is repeated every month to encompase any changes made that have affect on the past.
                              If for example 31 is chosen and a specific month does not have that day the logic will pick the first available date of said month.          
                            example: 12
                            format: int32
                            maximum: 31
                            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
                          leaveEntitlement:
                            nullable: true
                            properties:
                              excessLeaveToStatutory:
                                description: The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                              statutory:
                                description: The statutory leave (wetelijk verlof) linked employments are entitled to for a full time contract.
                                example: 160
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                              wtr:
                                description: The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          leaveRequest:
                            nullable: false
                            properties:
                              applyLeaveSchedule:
                                description: Indicates whether the leave schedule can be enterd and is so it is used when calculating the sugested leave hours for a leave request
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              leavePattern:
                                description: |
                                  The applicable leave pattern for a period of 2 weeks can be stored in this object. Each field contains the number of leave(work) hours for that day in the 2-week period. <br /> Please note that the `leavePattern` should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                                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
                              useHolidaysInCalculation:
                                description: |-
                                  Indicates whether the calculating for sugested leave hours for a leave request takes into account holidays. Is set to true no leave hours are calculated for "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."

                                  eg. When requesting leave for the 24th and 25th of december (25th being a national holiday) the calculation (8 hours a day) will return 8 when `useHolidaysInCalculation` is true and 16 when `useHolidaysInCalculation` is false
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                            readOnly: false
                            type: object
                          leaveUnitType:
                            description: Indicates what the unit type (hours or days) is. Employments linked to this leave policy use this leaveUnitType for their leave.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The key for the unit type
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the leave unit type
                                example: Uren
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          name:
                            description: The name of the leave policy
                            example: Normal leave
                            maxLength: 50
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          payoutLeaveImmediately:
                            description: If leave `accrualType` is set to based on hours worked (uren) then this field allows for the leave hours to be paid out directly instead of being accrued.
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          roundTo:
                            description: Indicates to how many digits after the decimal point to round the numbers
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The key for the roundTo
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the roundTo
                                example: "0.01"
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          roundingMethod:
                            description: "Indicates how to round the numbers "
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The key for the roundingMethod
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the roundingMethod
                                example: Logical
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: A single leave policy
      tags:
        - Leave policy
    put:
      description: |
        __Activity name :__ PutLeavePolicyByLeavePolicyId

        Edit the details of a leave policy
      operationId: PutLeavePolicyByLeavePolicyId
      parameters:
        - description: The unique identifier of the leave policy
          in: path
          name: leavePolicyId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                accrualType:
                  description: "Indicates how leave is accrued (yearly, monthly or hourly)  "
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      description: |
                        The key for the `accrualType`
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        The description for the `accrualType`
                      example: Jaar
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
                additionalLeave:
                  nullable: false
                  properties:
                    allocationType:
                      description: Indicates how additional leave is to be assigned to the employments (linked to this leave policy).
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          description: |
                            The key for the `additionalLeaveAllocationType`
                          example: 1
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          description: |
                            The description for the `additionalLeaveAllocationType`
                          example: Boek alleen hoogste waarde
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: false
                      type: object
                    referenceDate1:
                      description: If `referenceDate2` has a value only the last 6 months of the year are allowed as values
                      nullable: false
                      properties:
                        day:
                          description: The day of the first reference date.
                          example: 40
                          format: int32
                          maximum: 31
                          minimum: 1
                          nullable: false
                          readOnly: false
                          type: integer
                        month:
                          description: "The month of the first reference date "
                          format: metadata
                          nullable: false
                          properties:
                            key:
                              description: |
                                The key for the `referenceMonth`
                              example: 1
                              format: int32
                              nullable: false
                              readOnly: false
                              type: integer
                            value:
                              description: |
                                The description for the `referenceMonth`
                              example: Januari
                              nullable: false
                              readOnly: true
                              type: string
                          readOnly: false
                          type: object
                      type: object
                    referenceDate2:
                      description: Only use if applicable
                      nullable: true
                      properties:
                        day:
                          description: The day of the second reference date.
                          example: 40
                          format: int32
                          maximum: 31
                          minimum: 1
                          nullable: false
                          readOnly: false
                          type: integer
                        month:
                          description: "The month of the second reference date "
                          format: metadata
                          nullable: false
                          properties:
                            key:
                              description: |
                                The key for the `referenceMonth`
                              example: 1
                              format: int32
                              nullable: false
                              readOnly: false
                              type: integer
                            value:
                              description: |
                                The description for the `referenceMonth`
                              example: Januari
                              nullable: false
                              readOnly: true
                              type: string
                          readOnly: false
                          type: object
                      type: object
                  readOnly: false
                  type: object
                dayOfTheMonthToPerformAutomaticLeaveCalculationOn:
                  description: |-
                    They day of the month on which the automatic accrual of (yearly or monthly) leave is performed. The yearly calculation is repeated every month to encompase any changes made that have affect on the past.
                    If for example 31 is chosen and a specific month does not have that day the logic will pick the first available date of said month.          
                  example: 12
                  format: int32
                  maximum: 31
                  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
                leaveEntitlement:
                  nullable: true
                  properties:
                    excessLeaveToStatutory:
                      description: The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.
                      example: 40
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,3})(.\d{1,2})?$
                      readOnly: false
                      type: number
                    statutory:
                      description: The statutory leave (wetelijk verlof) linked employments are entitled to for a full time contract.
                      example: 160
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,3})(.\d{1,2})?$
                      readOnly: false
                      type: number
                    wtr:
                      description: The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                      example: 40
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,3})(.\d{1,2})?$
                      readOnly: false
                      type: number
                  readOnly: false
                  type: object
                leaveRequest:
                  nullable: false
                  properties:
                    applyLeaveSchedule:
                      description: Indicates whether the leave schedule can be enterd and is so it is used when calculating the sugested leave hours for a leave request
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                    leavePattern:
                      description: |
                        The applicable leave pattern for a period of 2 weeks can be stored in this object. Each field contains the number of leave(work) hours for that day in the 2-week period. <br /> Please note that the `leavePattern` should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                      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
                    useHolidaysInCalculation:
                      description: |-
                        Indicates whether the calculating for sugested leave hours for a leave request takes into account holidays. Is set to true no leave hours are calculated for "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."

                        eg. When requesting leave for the 24th and 25th of december (25th being a national holiday) the calculation (8 hours a day) will return 8 when `useHolidaysInCalculation` is true and 16 when `useHolidaysInCalculation` is false
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                  readOnly: false
                  type: object
                leaveUnitType:
                  description: Indicates what the unit type (hours or days) is. Employments linked to this leave policy use this leaveUnitType for their leave.
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      description: |
                        The key for the unit type
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        The description for the leave unit type
                      example: Uren
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
                name:
                  description: The name of the leave policy
                  example: Normal leave
                  maxLength: 50
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                payoutLeaveImmediately:
                  description: If leave `accrualType` is set to based on hours worked (uren) then this field allows for the leave hours to be paid out directly instead of being accrued.
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                roundTo:
                  description: Indicates to how many digits after the decimal point to round the numbers
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      description: |
                        The key for the roundTo
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        The description for the roundTo
                      example: "0.01"
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
                roundingMethod:
                  description: "Indicates how to round the numbers "
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      description: |
                        The key for the roundingMethod
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        The description for the roundingMethod
                      example: Logical
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
        description: Leave policy 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          accrualType:
                            description: "Indicates how leave is accrued (yearly, monthly or hourly)  "
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The key for the `accrualType`
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the `accrualType`
                                example: Jaar
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          additionalLeave:
                            nullable: false
                            properties:
                              allocationType:
                                description: Indicates how additional leave is to be assigned to the employments (linked to this leave policy).
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The key for the `additionalLeaveAllocationType`
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: |
                                      The description for the `additionalLeaveAllocationType`
                                    example: Boek alleen hoogste waarde
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: false
                                type: object
                              referenceDate1:
                                description: If `referenceDate2` has a value only the last 6 months of the year are allowed as values
                                nullable: false
                                properties:
                                  day:
                                    description: The day of the first reference date.
                                    example: 40
                                    format: int32
                                    maximum: 31
                                    minimum: 1
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  month:
                                    description: "The month of the first reference date "
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        description: |
                                          The key for the `referenceMonth`
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        description: |
                                          The description for the `referenceMonth`
                                        example: Januari
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    readOnly: false
                                    type: object
                                type: object
                              referenceDate2:
                                description: Only use if applicable
                                nullable: true
                                properties:
                                  day:
                                    description: The day of the second reference date.
                                    example: 40
                                    format: int32
                                    maximum: 31
                                    minimum: 1
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  month:
                                    description: "The month of the second reference date "
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        description: |
                                          The key for the `referenceMonth`
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        description: |
                                          The description for the `referenceMonth`
                                        example: Januari
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    readOnly: false
                                    type: object
                                type: object
                            readOnly: false
                            type: object
                          dayOfTheMonthToPerformAutomaticLeaveCalculationOn:
                            description: |-
                              They day of the month on which the automatic accrual of (yearly or monthly) leave is performed. The yearly calculation is repeated every month to encompase any changes made that have affect on the past.
                              If for example 31 is chosen and a specific month does not have that day the logic will pick the first available date of said month.          
                            example: 12
                            format: int32
                            maximum: 31
                            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
                          leaveEntitlement:
                            nullable: true
                            properties:
                              excessLeaveToStatutory:
                                description: The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                              statutory:
                                description: The statutory leave (wetelijk verlof) linked employments are entitled to for a full time contract.
                                example: 160
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                              wtr:
                                description: The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          leaveRequest:
                            nullable: false
                            properties:
                              applyLeaveSchedule:
                                description: Indicates whether the leave schedule can be enterd and is so it is used when calculating the sugested leave hours for a leave request
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              leavePattern:
                                description: |
                                  The applicable leave pattern for a period of 2 weeks can be stored in this object. Each field contains the number of leave(work) hours for that day in the 2-week period. <br /> Please note that the `leavePattern` should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                                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
                              useHolidaysInCalculation:
                                description: |-
                                  Indicates whether the calculating for sugested leave hours for a leave request takes into account holidays. Is set to true no leave hours are calculated for "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."

                                  eg. When requesting leave for the 24th and 25th of december (25th being a national holiday) the calculation (8 hours a day) will return 8 when `useHolidaysInCalculation` is true and 16 when `useHolidaysInCalculation` is false
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                            readOnly: false
                            type: object
                          leaveUnitType:
                            description: Indicates what the unit type (hours or days) is. Employments linked to this leave policy use this leaveUnitType for their leave.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The key for the unit type
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the leave unit type
                                example: Uren
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          name:
                            description: The name of the leave policy
                            example: Normal leave
                            maxLength: 50
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          payoutLeaveImmediately:
                            description: If leave `accrualType` is set to based on hours worked (uren) then this field allows for the leave hours to be paid out directly instead of being accrued.
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          roundTo:
                            description: Indicates to how many digits after the decimal point to round the numbers
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The key for the roundTo
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the roundTo
                                example: "0.01"
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          roundingMethod:
                            description: "Indicates how to round the numbers "
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The key for the roundingMethod
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the roundingMethod
                                example: Logical
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a leave policy
      tags:
        - Leave policy
  "/providers/employers/leavePolicies/{leavePolicyId}/agebasedleave":
    get:
      description: |
        __Activity name :__ GetAgeBasedLeaveByLeavePolicyId <br/>  <br/>  Returns the age based leave for the given leave policy.
      operationId: GetAgeBasedLeaveByLeavePolicyId
      parameters:
        - description: The unique identifier of the leave policy
          in: path
          name: leavePolicyId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            from:
                              nullable: false
                              properties:
                                numberOfMonths:
                                  description: the number of months of age to be applicable for the additional leave
                                  example: 0
                                  format: int32
                                  maximum: 11
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                numberOfYears:
                                  description: the employee's minimal age to be applicable for the additional leave
                                  example: 40
                                  format: int32
                                  maximum: 999
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              readOnly: false
                              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
                            leaveEntitlement:
                              nullable: false
                              properties:
                                excessLeaveToStatutory:
                                  description: |-
                                    The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.

                                    Either excessLeaveToStatutory or wtr must have a value
                                  example: 40
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,3})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                wtr:
                                  description: |-
                                    The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                                  

                                    Either excessLeaveToStatutory or wtr must have a value                
                                  example: 40
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,3})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                              readOnly: false
                              type: object
                            upToAndIncluding:
                              properties:
                                numberOfMonths:
                                  description: the number of months of age to be applicable for the additional leave
                                  example: 11
                                  format: int32
                                  maximum: 11
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                numberOfYears:
                                  description: the employee's minimal age to be applicable for the additional leave
                                  example: 50
                                  format: int32
                                  maximum: 999
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Age based leave
      tags:
        - Leave policy
    post:
      description: |
        __Activity name :__ PostAgeBasedLeaveByLeavePolicyId

        Add an age based leave 
      operationId: PostAgeBasedLeaveByLeavePolicyId
      parameters:
        - description: The unique identifier of the leave policy
          in: path
          name: leavePolicyId
          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 <TOKEN>
            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:
                from:
                  nullable: false
                  properties:
                    numberOfMonths:
                      description: the number of months of age to be applicable for the additional leave
                      example: 0
                      format: int32
                      maximum: 11
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                    numberOfYears:
                      description: the employee's minimal age to be applicable for the additional leave
                      example: 40
                      format: int32
                      maximum: 999
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                  readOnly: false
                  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
                leaveEntitlement:
                  nullable: false
                  properties:
                    excessLeaveToStatutory:
                      description: |-
                        The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.

                        Either excessLeaveToStatutory or wtr must have a value
                      example: 40
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,3})(.\d{1,2})?$
                      readOnly: false
                      type: number
                    wtr:
                      description: |-
                        The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                      

                        Either excessLeaveToStatutory or wtr must have a value                
                      example: 40
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,3})(.\d{1,2})?$
                      readOnly: false
                      type: number
                  readOnly: false
                  type: object
                upToAndIncluding:
                  properties:
                    numberOfMonths:
                      description: the number of months of age to be applicable for the additional leave
                      example: 11
                      format: int32
                      maximum: 11
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                    numberOfYears:
                      description: the employee's minimal age to be applicable for the additional leave
                      example: 50
                      format: int32
                      maximum: 999
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          from:
                            nullable: false
                            properties:
                              numberOfMonths:
                                description: the number of months of age to be applicable for the additional leave
                                example: 0
                                format: int32
                                maximum: 11
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                              numberOfYears:
                                description: the employee's minimal age to be applicable for the additional leave
                                example: 40
                                format: int32
                                maximum: 999
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                            readOnly: false
                            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
                          leaveEntitlement:
                            nullable: false
                            properties:
                              excessLeaveToStatutory:
                                description: |-
                                  The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.

                                  Either excessLeaveToStatutory or wtr must have a value
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                              wtr:
                                description: |-
                                  The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                                

                                  Either excessLeaveToStatutory or wtr must have a value                
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          upToAndIncluding:
                            properties:
                              numberOfMonths:
                                description: the number of months of age to be applicable for the additional leave
                                example: 11
                                format: int32
                                maximum: 11
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                              numberOfYears:
                                description: the employee's minimal age to be applicable for the additional leave
                                example: 50
                                format: int32
                                maximum: 999
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 age based leave record
      tags:
        - Leave policy
  "/providers/employers/leavePolicies/{leavePolicyId}/wagebasedleave":
    get:
      description: |
        __Activity name :__ GetWageBasedLeaveByLeavePolicyId <br/>  <br/>  Returns the wage based leave for the given leave policy.
      operationId: GetWageBasedLeaveByLeavePolicyId
      parameters:
        - description: The unique identifier of the leave policy
          in: path
          name: leavePolicyId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            fromWage:
                              description: the from wage the employment has to earn to be applicable for the additional leave
                              example: 40
                              format: double
                              maximum: 99999999999999.98
                              minimum: 0
                              nullable: false
                              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
                            leaveEntitlement:
                              nullable: false
                              properties:
                                excessLeaveToStatutory:
                                  description: |-
                                    The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.
                                                  

                                    Either excessLeaveToStatutory or wtr must have a value
                                  example: 40
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,14})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                wtr:
                                  description: |-
                                    The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                                  

                                    Either excessLeaveToStatutory or wtr must have a value
                                  example: 40
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,3})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                              readOnly: false
                              type: object
                            upToAndIncludingWage:
                              description: the up to and including wage the employment has to earn to be applicable for the additional leave
                              example: 40
                              format: double
                              maximum: 99999999999999.98
                              minimum: 0
                              nullable: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Wage based leave
      tags:
        - Leave policy
    post:
      description: |
        __Activity name :__ PostWageBasedLeaveByLeavePolicyId

        Add a wage based leave 
      operationId: PostWageBasedLeaveByLeavePolicyId
      parameters:
        - description: The unique identifier of the leave policy
          in: path
          name: leavePolicyId
          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 <TOKEN>
            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:
                fromWage:
                  description: the from wage the employment has to earn to be applicable for the additional leave
                  example: 40
                  format: double
                  maximum: 99999999999999.98
                  minimum: 0
                  nullable: false
                  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
                leaveEntitlement:
                  nullable: false
                  properties:
                    excessLeaveToStatutory:
                      description: |-
                        The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.
                                      

                        Either excessLeaveToStatutory or wtr must have a value
                      example: 40
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,14})(.\d{1,2})?$
                      readOnly: false
                      type: number
                    wtr:
                      description: |-
                        The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                      

                        Either excessLeaveToStatutory or wtr must have a value
                      example: 40
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,3})(.\d{1,2})?$
                      readOnly: false
                      type: number
                  readOnly: false
                  type: object
                upToAndIncludingWage:
                  description: the up to and including wage the employment has to earn to be applicable for the additional leave
                  example: 40
                  format: double
                  maximum: 99999999999999.98
                  minimum: 0
                  nullable: false
                  readOnly: false
                  type: number
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          fromWage:
                            description: the from wage the employment has to earn to be applicable for the additional leave
                            example: 40
                            format: double
                            maximum: 99999999999999.98
                            minimum: 0
                            nullable: false
                            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
                          leaveEntitlement:
                            nullable: false
                            properties:
                              excessLeaveToStatutory:
                                description: |-
                                  The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.
                                                

                                  Either excessLeaveToStatutory or wtr must have a value
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,14})(.\d{1,2})?$
                                readOnly: false
                                type: number
                              wtr:
                                description: |-
                                  The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                                

                                  Either excessLeaveToStatutory or wtr must have a value
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          upToAndIncludingWage:
                            description: the up to and including wage the employment has to earn to be applicable for the additional leave
                            example: 40
                            format: double
                            maximum: 99999999999999.98
                            minimum: 0
                            nullable: false
                            readOnly: false
                            type: number
                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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 wage based leave record
      tags:
        - Leave policy
  "/providers/employers/leavePolicies/{leavePolicyId}/yearsofservicebasedleave":
    get:
      description: |
        __Activity name :__ GetYearsOfServiceBasedLeaveByLeavePolicyId <br/>  <br/>  Returns the years of service based leave for the given leave policy.
      operationId: GetYearsOfServiceBasedLeaveByLeavePolicyId
      parameters:
        - description: The unique identifier of the leave policy
          in: path
          name: leavePolicyId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            from:
                              properties:
                                numberOfMonths:
                                  description: the number of months of service to be applicable for the additional leave
                                  example: 0
                                  format: int32
                                  maximum: 11
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                numberOfYears:
                                  description: the number of years of service to be applicable for the additional leave
                                  example: 40
                                  format: int32
                                  maximum: 999
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              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
                            leaveEntitlement:
                              nullable: false
                              properties:
                                excessLeaveToStatutory:
                                  description: |-
                                    The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.

                                    Either excessLeaveToStatutory or wtr must have a value
                                  example: 40
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,3})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                wtr:
                                  description: |-
                                    The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.

                                    Either excessLeaveToStatutory or wtr must have a value
                                  example: 40
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,3})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                              readOnly: false
                              type: object
                            upToAndIncluding:
                              properties:
                                numberOfMonths:
                                  description: the number of months of service to be applicable for the additional leave
                                  example: 0
                                  format: int32
                                  maximum: 11
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                numberOfYears:
                                  description: the number of years of service to be applicable for the additional leave
                                  example: 40
                                  format: int32
                                  maximum: 999
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: years of service based leave
      tags:
        - Leave policy
    post:
      description: |
        __Activity name :__ PostYearsOfServiceBasedLeaveByLeavePolicyId

        Add a years of service based leave 
      operationId: PostYearsOfServiceBasedLeaveByLeavePolicyId
      parameters:
        - description: The unique identifier of the leave policy
          in: path
          name: leavePolicyId
          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 <TOKEN>
            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:
                from:
                  properties:
                    numberOfMonths:
                      description: the number of months of service to be applicable for the additional leave
                      example: 0
                      format: int32
                      maximum: 11
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                    numberOfYears:
                      description: the number of years of service to be applicable for the additional leave
                      example: 40
                      format: int32
                      maximum: 999
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                  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
                leaveEntitlement:
                  nullable: false
                  properties:
                    excessLeaveToStatutory:
                      description: |-
                        The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.

                        Either excessLeaveToStatutory or wtr must have a value
                      example: 40
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,3})(.\d{1,2})?$
                      readOnly: false
                      type: number
                    wtr:
                      description: |-
                        The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.

                        Either excessLeaveToStatutory or wtr must have a value
                      example: 40
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,3})(.\d{1,2})?$
                      readOnly: false
                      type: number
                  readOnly: false
                  type: object
                upToAndIncluding:
                  properties:
                    numberOfMonths:
                      description: the number of months of service to be applicable for the additional leave
                      example: 0
                      format: int32
                      maximum: 11
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                    numberOfYears:
                      description: the number of years of service to be applicable for the additional leave
                      example: 40
                      format: int32
                      maximum: 999
                      minimum: 0
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          from:
                            properties:
                              numberOfMonths:
                                description: the number of months of service to be applicable for the additional leave
                                example: 0
                                format: int32
                                maximum: 11
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                              numberOfYears:
                                description: the number of years of service to be applicable for the additional leave
                                example: 40
                                format: int32
                                maximum: 999
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                            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
                          leaveEntitlement:
                            nullable: false
                            properties:
                              excessLeaveToStatutory:
                                description: |-
                                  The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.

                                  Either excessLeaveToStatutory or wtr must have a value
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                              wtr:
                                description: |-
                                  The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.

                                  Either excessLeaveToStatutory or wtr must have a value
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          upToAndIncluding:
                            properties:
                              numberOfMonths:
                                description: the number of months of service to be applicable for the additional leave
                                example: 0
                                format: int32
                                maximum: 11
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                              numberOfYears:
                                description: the number of years of service to be applicable for the additional leave
                                example: 40
                                format: int32
                                maximum: 999
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 years of service based leave record
      tags:
        - Leave policy
  "/providers/employers/leavepolicies/{leavePolicyId}/employments":
    get:
      description: |
        __Activity name:__ GetEmploymentsByLeavePolicyId
        Get the list of employments that are linked for this leave policy.
        When a leave policy and an employment are linked, that means the employment will be provided with leave based on the policy.
      operationId: GetEmploymentsByLeavePolicyId
      parameters:
        - description: The unique identifier of the leave policy
          in: path
          name: leavePolicyId
          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 <TOKEN>
            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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: false
                          properties:
                            employee:
                              format: metadata
                              nullable: false
                              properties:
                                dateOfBirth:
                                  description: |
                                    The date of birth
                                  example: 1995-05-21
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                employeeNumber:
                                  description: The employee number to uniquely identify a employee within a 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
                                lastNamePartner:
                                  description: The last name of the partner of the employee
                                  example: Wiel
                                  maxLength: 25
                                  nullable: true
                                  readOnly: true
                                  type: string
                                photo:
                                  description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                  example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                  format: url
                                  nullable: true
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the employee
                                  example: van
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                                prefixPartner:
                                  description: The prefix of the partner of the employee
                                  example: van de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            endDate:
                              description: The date on which this employment ends.
                              example: 2021-12-31
                              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: 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: 1
                              format: int32
                              maximum: 9999
                              nullable: false
                              readOnly: true
                              type: integer
                            startDate:
                              description: The date on which this employment starts.
                              example: 2020-01-01
                              format: date
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 list of linked employments for the leave policy
      tags:
        - Leave policy and employment links
    patch:
      description: |
        __Activity name:__ PatchEmploymentsByLeavePolicyId
        This endpoint enables the user to create or delete multiple 'linkages' with one call. This is mostly useful updating a larger number of employments for the given leave policy.
      operationId: PatchEmploymentsByLeavePolicyId
      parameters:
        - description: The unique identifier of the leave policy
          in: path
          name: leavePolicyId
          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 <TOKEN>
            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.
                    enum:
                      - link
                      - unlink
                    nullable: false
                    readOnly: false
                    type: string
                  id:
                    description: The unique identifier (GUID/UUID) of the employment
                    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: array
        description: The request body contains an array of objects containing a `employment` and an `action` field.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Create or delete multiple linked employments for the leave policy
      tags:
        - Leave policy and employment links
  /providers/employers/minimized:
    get:
      description: |
        __Activity name :__ GetEmployersMinimizedByUser

        Get a list of all employers accessible to the current user.  With this endpoint we introduced the "Minimized" resource which contains fewer fields then `/providers/employers`. This version should increase performance when requesting employments for large employers.
      operationId: GetEmployersMinimizedByUser
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - properties:
                                address:
                                  allOf:
                                    - properties:
                                        city:
                                          description: City of the address
                                          example: Leiden
                                          maxLength: 24
                                          nullable: false
                                          readOnly: false
                                          type: string
                                        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
                                        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
                                companyName:
                                  description: Name of the company
                                  example: Voorbeeld B.V.
                                  maxLength: 70
                                  nullable: false
                                  readOnly: false
                                  type: string
                                contact:
                                  properties:
                                    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:
                                  properties:
                                    phoneNumber:
                                      description: The telephone number of the employer
                                      example: (088) 31 11150
                                      maxLength: 15
                                      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
                                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
                                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:
                                  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
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 with fewer fields for performance reasons
      tags:
        - Employer
  "/providers/employers/notes/{noteId}":
    delete:
      description: |
        __Activity name :__ DeleteEmployerNoteByNoteId

        Delete an existing note record
      operationId: DeleteEmployerNoteByNoteId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: noteId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employer note record
      tags:
        - Employer notes
    get:
      description: |
        __Activity name :__ GetEmployerNoteByNoteId

        Get the details of a note
      operationId: GetEmployerNoteByNoteId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: noteId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            accessibleBy:
                              description: |
                                Indicates who can view this node.
                              nullable: false
                              properties:
                                key:
                                  description: The key for accessible by
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: Description of the accessible by
                                  example: Everyone
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            createdBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            createdOn:
                              description: |
                                The date on which the note was created
                              example: 2018-01-01
                              format: date-time
                              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
                            lastModifiedBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            lastModifiedOn:
                              description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                              example: 2018-01-01
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            note:
                              description: |-
                                The note it self.

                                __Note:__ This is a free text field so users can add htlm/script etc.
                              example: Remember to do xyz
                              maxLength: 4000
                              nullable: true
                              readOnly: false
                              type: string
                            subject:
                              description: subject of the note
                              example: Remember to do xyz
                              maxLength: 250
                              nullable: false
                              readOnly: false
                              type: string
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employer note
      tags:
        - Employer notes
    put:
      description: |
        __Activity name :__ PutEmployerNoteByNoteId

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.
      operationId: PutEmployerNoteByNoteId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: noteId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                accessibleBy:
                  description: |
                    Indicates who can view this node.
                  nullable: false
                  properties:
                    key:
                      description: The key for accessible by
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: Description of the accessible by
                      example: Everyone
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                createdBy:
                  format: metadata
                  nullable: true
                  properties:
                    formattedName:
                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                createdOn:
                  description: |
                    The date on which the note was created
                  example: 2018-01-01
                  format: date-time
                  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
                lastModifiedBy:
                  format: metadata
                  nullable: true
                  properties:
                    formattedName:
                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                lastModifiedOn:
                  description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                  example: 2018-01-01
                  format: date-time
                  nullable: false
                  readOnly: true
                  type: string
                note:
                  description: |-
                    The note it self.

                    __Note:__ This is a free text field so users can add htlm/script etc.
                  example: Remember to do xyz
                  maxLength: 4000
                  nullable: true
                  readOnly: false
                  type: string
                subject:
                  description: subject of the note
                  example: Remember to do xyz
                  maxLength: 250
                  nullable: false
                  readOnly: false
                  type: string
              type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          accessibleBy:
                            description: |
                              Indicates who can view this node.
                            nullable: false
                            properties:
                              key:
                                description: The key for accessible by
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: Description of the accessible by
                                example: Everyone
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          createdBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          createdOn:
                            description: |
                              The date on which the note was created
                            example: 2018-01-01
                            format: date-time
                            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
                          lastModifiedBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          lastModifiedOn:
                            description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                            example: 2018-01-01
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          note:
                            description: |-
                              The note it self.

                              __Note:__ This is a free text field so users can add htlm/script etc.
                            example: Remember to do xyz
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          subject:
                            description: subject of the note
                            example: Remember to do xyz
                            maxLength: 250
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit an employer note record
      tags:
        - Employer notes
  /providers/employers/notifications:
    patch:
      description: |
        __Activity name :__ PatchNotificationsByEmployerId

        Mark notifications as read
      operationId: PatchNotifications
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 notification
                    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 notifications 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 notifications as read.
      tags:
        - Notification
  "/providers/employers/payrollAdministrations/{payrollAdministrationId}/mdvNotifications":
    patch:
      description: |
        __Activity name :__ PatchMdvNotificationsByPayrollAdministrationId

        Mdv notifications
      operationId: PatchMdvNotificationsByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            pattern: ^Bearer\s[\w-]+$
            type: string
        - description: The unique identifier of an administration
          in: path
          name: payrollAdministrationId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            employee:
                              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
                                dateOfBirth:
                                  description: |
                                    The date of birth
                                  example: 1995-05-21
                                  format: date
                                  nullable: false
                                  readOnly: false
                                  type: string
                                gender:
                                  description: gender indication
                                  example: M
                                  maxLength: 1
                                  nullable: false
                                  readOnly: true
                                  type: string
                                initials:
                                  description: |
                                    The initials
                                  example: S.L.
                                  maxLength: 6
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                lastName:
                                  description: |
                                    The last name, family name or surname as part of a persons personal name.
                                  example: Bergen
                                  maxLength: 25
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                prefix:
                                  description: |
                                    The prefix to the last name
                                  example: van
                                  maxLength: 10
                                  minLength: 1
                                  nullable: true
                                  readOnly: false
                                  type: string
                              readOnly: true
                              type: object
                            employment:
                              properties:
                                claExternalParty:
                                  description: "CLA (CAO) code in case of a deviating CLA for external parties . NL: CaoKlantgroepAfwijkend"
                                  example: 2
                                  format: int32
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                endDate:
                                  description: The date on which the employment ends.
                                  example: 2018-10-23
                                  format: date
                                  nullable: true
                                  readOnly: true
                                  type: string
                                startDate:
                                  description: The date on which this employment starts.
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            payrollAdministration:
                              properties:
                                payrollTaxesNumber:
                                  description: The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst.
                                  example: 111111110L46
                                  maxLength: 12
                                  minLength: 12
                                  nullable: true
                                  readOnly: false
                                  type: string
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: MDV notifications
      tags:
        - Mdv notifications
  "/providers/employers/payrolladministrations/apgpensiondeclarations/{apgPensionDeclarationId}":
    get:
      description: |
        __Activity name :__ GetApgPensionDeclarationByApgPensionDeclarationId


        Details of APG pension declaration
      operationId: GetApgPensionDeclarationByApgPensionDeclarationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll tax return
          in: path
          name: apgPensionDeclarationId
          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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          apgPensionDeclarationStatus:
                            description: |
                              The current status of the tax return
                              Possible values:
                              * Verzoek tot aanmaak pensioenaangifte (key = 1)
                              * Fout bij aanmaken pensioenaangifte (key = 2)
                              * Pensioenaangifte aangemaakt (key = 3)
                              * Pensioenaangifte geannuleerd (key = 4)
                              * Pensioenaangifte bevestigd (key = 5)
                              * Pensioenaangifte verzonden (key = 6)
                              * Pensioenaangifte verwijderd (key = 7)
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 3
                                format: int32
                                type: integer
                              value:
                                example: Pensioenaangifte aangemaakt
                                type: string
                            readOnly: true
                            type: object
                          approvalTime:
                            description: The time at which the payroll run was approved by the user
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          approvedBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          cancelledBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          cancelledTime:
                            description: The time at which the payroll run was Cancelled by the user
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          creationTime:
                            description: The time at which the pension message was requested by the user
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          customerGroupNumber:
                            description: Pension declarations will alway be grouped by its customerGroupNumber (klantgroepnummer).
                            format: int32
                            nullable: false
                            readOnly: true
                            type: integer
                          externalParty:
                            description: External party (externe partij)
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 13
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: PFZW (APG)
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            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
                          messageReference:
                            description: |
                              The message reference (berichtkenmerk) to recognize the given declaration.
                            example: "190"
                            nullable: true
                            readOnly: true
                            type: string
                          methodOfCreation:
                            description: Method by which the creation of the run was triggered.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Individueel
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          period:
                            format: metadata
                            properties:
                              periodEndDate:
                                description: The end date of the period
                                example: 2021-11-30
                                format: date
                                nullable: false
                                readOnly: false
                                type: string
                              periodId:
                                description: The periodId of the payroll period.
                                example: 202101
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              periodNumber:
                                description: The period number of the payroll period for which the pension declaration was created. In case of a yearly tax return this value will be set to 0
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              periodStartDate:
                                description: The start date of the period
                                example: 2021-11-01
                                format: date
                                nullable: false
                                readOnly: false
                                type: string
                              periodType:
                                description: Indicates the frequence of the process. Payrolling can be done on a montly, 4-weekly or weekly basis.
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  value:
                                    example: month
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              year:
                                description: The year of the period for which the pension declaration was created.
                                example: 2017
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                            type: object
                          removeTime:
                            description: The time at which the pay roll run was removed.
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          removedBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          requestTime:
                            description: The time at which the  run was requested by the user
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          requestedBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          responseMessages:
                            items:
                              properties:
                                datetimeOfMessageReceipt:
                                  description: The date on which the original message was received by the external entity
                                  example: 2016-01-19
                                  format: date-time
                                  nullable: true
                                  readOnly: true
                                  type: string
                                datetimeOfRegistration:
                                  description: The date on which the response message was registered in Loket
                                  example: 2016-01-19
                                  format: date-time
                                  nullable: false
                                  readOnly: true
                                  type: string
                                description:
                                  description: The description of the response message
                                  example: Bestand ontvangen
                                  nullable: true
                                  readOnly: true
                                  type: string
                              type: object
                            type: array
                          sentTime:
                            description: The time at which the pay roll run was sent.
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          withholdingAgentName:
                            description: |
                              The withholding agent name (naam inhoudingsplichtige) for this return.
                            example: Ben-Hur BV Via Roma
                            nullable: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Detail APG pension declaration for an administration
      tags:
        - Apg pension declaration
    patch:
      description: |
        __Activity name :__ PatchApgPensionDeclarationByApgPensionDeclarationId


        This endpoints changes the status of the Apg pensiondeclaration based on the provided action.
      operationId: PatchApgPensionDeclarationByApgPensionDeclarationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: apgPensionDeclarationId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                action:
                  description: The action to perform on the apg pensiondeclaration
                  enum:
                    - confirm
                    - cancel
                  nullable: false
                  readOnly: false
                  type: string
              required:
                - id
                - action
              type: object
        description: |
          The request body contains the action (cancel / confirm)
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the status of a apg pension declaration
      tags:
        - Apg pension declaration
  "/providers/employers/payrolladministrations/apgpensiondeclarations/{apgPensionDeclarationId}/message":
    get:
      description: |
        __Activity name :__ GetMessageByApgPensionDeclarationId  


        Download the message of the APG pension declaration (pensioenaangiftebericht) in xml. Please note that this does NOT refer to the response message, but to the initial message i.e. pensioenaangiftebericht.
      operationId: GetMessageByApgPensionDeclarationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll tax return
          in: path
          name: apgPensionDeclarationId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/xml:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download the message of a of an APG pension declaration
      tags:
        - Apg pension declaration
  "/providers/employers/payrolladministrations/apgpensiondeclarations/{apgPensionDeclarationId}/overview":
    get:
      description: |
        __Activity name :__ GetOverviewByApgPensionDeclarationId


        Download the APG pension declaration overiew
      operationId: GetOverviewByApgPensionDeclarationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll tax return
          in: path
          name: apgPensionDeclarationId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download the overview report of an APG pension declaration
      tags:
        - Apg pension declaration
  "/providers/employers/payrolladministrations/journalruns/{journalrunId}":
    get:
      description: |
        __Activity name :__ GetJournalRunByJournalRunId

        Returns the details of a journal run. </br>
      operationId: GetJournalRunByJournalRunId
      parameters:
        - description: The unique identifier of the payroll run
          in: path
          name: journalrunId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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)
                            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
                          journalRunStatus:
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  Possible values for the payroll run status are;

                                  * 0	Staat klaar voor journaliseren
                                  * 1	Geen journaal resultaten
                                  * 2	Fout bij aanmaken
                                  * 3	Verwijderd door gebruiker
                                  * 4	Journaal gereed
                                  * 5	Wordt geëxporteerd
                                  * 6	Exporteren mislukt
                                  * 7	Journaal geëxporteerd
                                example: 4
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: The value describing the current status of the payroll run.
                                example: Journaal gereed
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          methodOfCreation:
                            description: Method by which the creation of the journal run was triggered.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Individueel
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          payrollRun:
                            properties:
                              payrollPeriod:
                                format: metadata
                                properties:
                                  periodEndDate:
                                    description: The last day of the period for which the tax return message was created
                                    example: 2018-01-31
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  periodNumber:
                                    description: The period number of the payroll period the record relates to
                                    example: 1
                                    format: int32
                                    nullable: true
                                    readOnly: false
                                    type: integer
                                  periodStartDate:
                                    description: The first day of the period for which the tax return message was created
                                    example: 2018-01-01
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  testYear:
                                    description: |-
                                      Indicates whether the payroll periode is part of a test year.

                                      In Loket it is possible to run a year of a payrolladministration as a so-called test year.  This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. 
                                      Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
                                    example: false
                                    nullable: false
                                    readOnly: true
                                    type: boolean
                                  year:
                                    description: The year of the payroll period the record relates to
                                    example: 2017
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                type: object
                              payrollRunId:
                                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
                              sequenceNumberApproved:
                                description: "Ascending sequence number related to an approved payrol run. A payroll run may have more than one journal run. With this number the journal run may be linked to the specific payroll run. "
                                example: 6
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                            type: object
                          processingFinishedTime:
                            description: The time at which at which the journal run was finished processing
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          removeTime:
                            description: The time at which the journal run was removed.
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          removedBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          requestTime:
                            description: The time at which the payroll run was requested by the user
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          requestedBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          sequenceNumber:
                            description: Ascending sequence number over ALL journal runs for the payroll administration.
                            example: 8
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 journal run
      tags:
        - Journal run
    patch:
      description: |
        __Activity name :__ PatchJournalRunByJournalRunId

        Update the status of a journal run
        * Action 'markAsSuccessfullyExported'; will change the status of the journal run to 'exported'. Please note this action will not perform an actual export, but simply allows the user the manage status to match their actualities.</br>
        * Action 'MarkAsProcessingFailed'; will change the status of the journal run to 'export failed'. Please note this action will not perform an actual export, but simply allows the user the manage status to match their actualities.
      operationId: PatchJournalRunByJournalRunId
      parameters:
        - description: The unique identifier of the payroll run
          in: path
          name: journalrunId
          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 <TOKEN>
            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 the journal run
                    * MarkAsProcessed  --> (from the loket.nl point of view) Indicates that the client succesfully processed the data (indicating that the results were imported in the financial application).
                    * MarkAsProcessingFailed --> (from the loket.nl point of view) Indicates that the client was unable to process the results. Use the `message` field to communicate the error(s).
                  enum:
                    - MarkAsProcessed
                    - MarkAsProcessingFailed
                  nullable: false
                  readOnly: false
                  type: string
                application:
                  description: The application that downloaded and processed the results
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Financieel pakket 1
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
                message:
                  description: Message to be displayed to the loket.nl user
                  maxLength: 255
                  nullable: true
                  readOnly: false
                  type: string
        description: Change the status of a journal run
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Change the status of a journal run
      tags:
        - Journal run
  "/providers/employers/payrolladministrations/journalruns/{journalrunId}/download":
    post:
      description: |
        __Activity name :__ PostDownloadJournalRunExportByJournalRunId

        Download a journal run to a journal application. Use the defaults and metadata to acquire the journal application settings.
      operationId: PostDownloadJournalRunExportByJournalRunId
      parameters:
        - description: The unique identifier of the payroll run
          in: path
          name: journalrunId
          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 <TOKEN>
            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: Date
                  example: 2022-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                includeCostCenter:
                  description: Indicates whether cost centers are included in the journal.
                  example: true
                  nullable: false
                  readOnly: false
                  type: boolean
                includeCostUnit:
                  description: Indicates whether cost units are included in the journal.
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
        description: Download the journal run to an external application
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          date:
                            description: Date
                            example: 2022-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          includeCostCenter:
                            description: Indicates whether cost centers are included in the journal.
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          includeCostUnit:
                            description: Indicates whether cost units are included in the journal.
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                    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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Download the journal run
      tags:
        - Journal run
  "/providers/employers/payrolladministrations/journalruns/{journalrunId}/errors":
    get:
      description: |
        __Activity name :__ GetJournalRunErrorsByJournalRunId

        Errors that occured while processing the journalrun can be obtained via this endpoint.
      operationId: GetJournalRunErrorsByJournalRunId
      parameters:
        - description: The unique identifier of the payroll run
          in: path
          name: journalrunId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            PayrollEmployeeNumber:
                              description: The number of the employment in relation to the payroll administration.
                              example: 202
                              format: int32
                              nullable: false
                              readOnly: true
                              type: integer
                            costCenter:
                              description: |
                                The cost center on which the data for this entry will be booked for the ledger.

                                `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                              format: metadata
                              nullable: true
                              properties:
                                code:
                                  example: SAL073
                                  nullable: false
                                  readOnly: true
                                  type: string
                                description:
                                  example: Sales Den Bosch
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              type: object
                            costUnit:
                              description: |
                                The cost unit on which the data for this entry will be booked for the ledger.

                                `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                              format: metadata
                              nullable: true
                              properties:
                                code:
                                  example: "01"
                                  nullable: false
                                  readOnly: true
                                  type: string
                                description:
                                  example: Cars
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              type: object
                            error:
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: The error code
                                  example: 4
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  description: The description of the error
                                  example: Geen verdeling gevonden voor de component, kostenplaats, kostendrager combinatie
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            generalLedgerAccount:
                              description: |
                                General ledger account number and description

                                `generalLedgerAccount` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                              format: metadata
                              nullable: true
                              properties:
                                code:
                                  description: The general ledger accounting number (grootboekrekeningnummer)
                                  example: "4002020"
                                  nullable: false
                                  readOnly: true
                                  type: string
                                description:
                                  description: Description for the general ledger accounting number.
                                  example: Cars
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  description: Database id (unique per administration).
                                  example: 4
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              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
                            payrollComponent:
                              description: |
                                A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                                `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                              format: metadata
                              nullable: true
                              properties:
                                description:
                                  description: |
                                    The description of the payroll component
                                  example: KINDEROPV.BEL
                                  maxLength: 14
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  description: |
                                    The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know it by heart.
                                  example: 286
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                          type: object
                        type: array
                    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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Errors of a journal run
      tags:
        - Journal run
  "/providers/employers/payrolladministrations/journalruns/{journalrunId}/exportAuditTrail":
    get:
      description: |
        __Activity name :__ GetJournalRunExportAuditTrailByJournalRunId

        Returns the export audit trail for a journal run
      operationId: GetJournalRunExportAuditTrailByJournalRunId
      parameters:
        - description: The unique identifier of the payroll run
          in: path
          name: journalrunId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            exportStatus:
                              description: The status of the export
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: |
                                    The status of the export (succesfull or failed)            
                                  example: 4
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  description: The value describing the current status of the payroll run.
                                  example: Downloaded
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            exportedBy:
                              format: metadata
                              nullable: false
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            exportedOn:
                              description: The time at which the export was started
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            exportedTo:
                              description: The (financial) application to which the journal results where send
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: Finance Plus
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              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
                            methodOfExporting:
                              description: The ways by which the journal results where exported (download/API call)
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: Download
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            returendErrorMessage:
                              description: Incase the export (by means of an API) failed the returned errors are provided here.
                              example: Could not find cost center Sales
                              maxLength: 4000
                              nullable: true
                              readOnly: true
                              type: string
                            sequenceNumber:
                              description: Ascending sequence number over ALL journal runs within a yearfor the payroll administration.
                              example: 8
                              format: int32
                              nullable: false
                              readOnly: true
                              type: integer
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 export attempts for a journal run
      tags:
        - Journal run
  "/providers/employers/payrolladministrations/journalruns/{journalrunId}/results":
    get:
      description: |
        __Activity name :__ GetJournalRunResultsByJournalRunId

        Returns the journal run results for the journal run. Journal runs with journalRunStatus = 0,1,2,3 dont have results and this endpoint will return an error if called for a journal run with that status.
      operationId: GetJournalRunResultsByJournalRunId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll run
          in: path
          name: journalrunId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            costCenter:
                              description: |
                                The cost center on which the data for this entry will be booked for the ledger.

                                `costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                              format: metadata
                              nullable: true
                              properties:
                                code:
                                  example: SAL073
                                  nullable: false
                                  readOnly: true
                                  type: string
                                description:
                                  example: Sales Den Bosch
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              type: object
                            costUnit:
                              description: |
                                The cost unit on which the data for this entry will be booked for the ledger.

                                `costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                              format: metadata
                              nullable: true
                              properties:
                                code:
                                  example: "01"
                                  nullable: false
                                  readOnly: true
                                  type: string
                                description:
                                  example: Cars
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              type: object
                            creditAmount:
                              description: |
                                The credit amount for the ledger entry.
                              example: 0
                              nullable: false
                              readOnly: true
                              type: number
                            debetAmount:
                              description: |
                                The debet amount for the ledger entry.
                              example: 500.87
                              nullable: false
                              readOnly: true
                              type: number
                            generalLedgerAccount:
                              description: |
                                General ledger account number and description

                                `generalLedgerAccount` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                code:
                                  description: The general ledger accounting number (grootboekrekeningnummer)
                                  example: "4002020"
                                  nullable: false
                                  readOnly: true
                                  type: string
                                description:
                                  description: Description for the general ledger accounting number.
                                  example: Cars
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  description: Database id (unique per administration).
                                  example: 4
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              type: object
                            payrollComponent:
                              description: |
                                A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                                `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                              format: metadata
                              nullable: true
                              properties:
                                description:
                                  description: |
                                    The description of the payroll component
                                  example: KINDEROPV.BEL
                                  maxLength: 14
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  description: |
                                    The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know it by heart.
                                  example: 286
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 journal results for a journal run
      tags:
        - Journal run results
  "/providers/employers/payrolladministrations/journalruns/{journalrunId}/runoverview":
    get:
      description: |
        __Activity name :__ GetRunOverviewByJournalRunId

        Returns the journal run overview in csv for the journal run. Journal runs with journalRunStatus = 0,1,2,3 dont have results and this endpoint will return an error if called for a journal run with that status.
      operationId: GetRunOverviewByJournalRunId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll run
          in: path
          name: journalrunId
          required: true
          schema:
            format: uuid
            type: string
        - description: Dagboeknummer.
          example: 123
          in: query
          name: reportJournalNumber
          required: true
          schema:
            format: int32
            type: integer
        - description: Boekstuknummer.
          example: 456
          in: query
          name: reportVoucherNumber
          required: true
          schema:
            format: int32
            type: integer
        - description: Omschrijving to be shown on the overview.
          example: 123
          in: query
          name: reportDescription
          required: false
          schema:
            type: string
        - description: A valid year to be shown on the report.
          example: "2018"
          in: query
          name: reportYear
          required: true
          schema:
            format: int32
            type: integer
        - description: A valid period number to be shown on the report.
          example: "01"
          in: query
          name: reportPeriodNumber
          required: true
          schema:
            format: int32
            type: integer
        - description: A valid booking date to be shown on the report.
          example: 2018-01-01
          in: query
          name: reportDate
          required: true
          schema:
            format: date
            type: string
      responses:
        "200":
          content:
            text/csv:
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 journal run overview for a journal run
      tags:
        - Journal run overview
  "/providers/employers/payrolladministrations/journalruns/{journalrunId}/runoverviewperemployment":
    get:
      description: |
        __Activity name :__ GetRunOverviewPerEmploymentByJournalRunId

        Returns the journal run overview in csv for the journal run. Journal runs with journalRunStatus = 0,1,2,3 dont have results and this endpoint will return an error if called for a journal run with that status.
      operationId: GetRunOverviewPerEmploymentByJournalRunId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll run
          in: path
          name: journalrunId
          required: true
          schema:
            format: uuid
            type: string
        - description: Dagboeknummer.
          example: 123
          in: query
          name: reportJournalNumber
          required: true
          schema:
            format: int32
            type: integer
        - description: Boekstuknummer.
          example: 456
          in: query
          name: reportVoucherNumber
          required: true
          schema:
            format: int32
            type: integer
        - description: Omschrijving to be shown on the overview.
          example: 123
          in: query
          name: reportDescription
          required: false
          schema:
            type: string
        - description: A valid year to be shown on the report.
          example: "2018"
          in: query
          name: reportYear
          required: true
          schema:
            format: int32
            type: integer
        - description: A valid period number to be shown on the report.
          example: "01"
          in: query
          name: reportPeriodNumber
          required: true
          schema:
            format: int32
            type: integer
        - description: A valid booking date to be shown on the report.
          example: 2018-01-01
          in: query
          name: reportDate
          required: true
          schema:
            format: date
            type: string
      responses:
        "200":
          content:
            text/csv:
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 journal run overview per employment for a journal run
      tags:
        - Journal run overview
  "/providers/employers/payrolladministrations/journalruns/{journalrunId}/send":
    post:
      description: |
        __Activity name :__ PostSendJournalRunExportByJournalRunId

        Send a journal run to a journal application. Use the defaults and metadata to acquire the journal application settings. The defaults endpoint contains values for all required fields. 

        There are two metadata endpoints: 

        - /journalruns/{journalrunId}/send/metadata

        - /journalruns/{journalrunId}/send/metadata/accountId/{accountId}
      operationId: PostSendJournalRunExportByJournalRunId
      parameters:
        - description: The unique identifier of the payroll run
          in: path
          name: journalrunId
          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 <TOKEN>
            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:
                account:
                  description: The account to connect to the journal application.
                  nullable: true
                  properties:
                    id:
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Account Jan
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
                accountKey:
                  example: User1
                  nullable: true
                  readOnly: false
                  type: string
                administration:
                  description: The administration in the journalapplication to which the journal will be added.
                  nullable: true
                  properties:
                    id:
                      example: 223
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Administration A
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
                date:
                  description: Date
                  example: 2022-01-01
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                description:
                  example: Opmerking 1
                  nullable: true
                  readOnly: false
                  type: string
                deviatingJournalSeries:
                  example: Afwijking1
                  nullable: true
                  readOnly: false
                  type: string
                financialYear:
                  example: 2023
                  format: int32
                  nullable: true
                  readOnly: false
                  type: integer
                includeCostCenter:
                  description: Indicates whether cost centers are included in the journal.
                  example: true
                  nullable: true
                  readOnly: false
                  type: boolean
                includeCostUnit:
                  description: Indicates whether cost units are included in the journal.
                  example: false
                  nullable: true
                  readOnly: false
                  type: boolean
                journalCode:
                  example: "2"
                  nullable: true
                  readOnly: false
                  type: string
                journalNumber:
                  example: 2
                  format: int32
                  nullable: true
                  readOnly: false
                  type: integer
                linkCostCenterToGroup:
                  description: |
                    The Group to which the CostCenter will be linked.
                  example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                  format: uuid
                  nullable: true
                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                  readOnly: false
                  type: string
                linkCostUnitToGroup:
                  description: |
                    The Group to which the CostUnit will be linked.
                  example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                  format: uuid
                  nullable: true
                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                  readOnly: false
                  type: string
                period:
                  description: the period to which the journal should be added.
                  example: 2
                  format: int32
                  nullable: true
                  readOnly: false
                  type: integer
                subAdministration:
                  description: The subadministration in the journalapplication to which the journal will be added.
                  nullable: true
                  properties:
                    Id:
                      example: 223
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    Name:
                      example: Administration A
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
                user:
                  example: User1
                  nullable: true
                  readOnly: true
                  type: string
        description: Send the journal run to an external application
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          account:
                            description: The account to connect to the journal application.
                            nullable: true
                            properties:
                              id:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Account Jan
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          accountKey:
                            example: User1
                            nullable: true
                            readOnly: false
                            type: string
                          administration:
                            description: The administration in the journalapplication to which the journal will be added.
                            nullable: true
                            properties:
                              id:
                                example: 223
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Administration A
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          date:
                            description: Date
                            example: 2022-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          description:
                            example: Opmerking 1
                            nullable: true
                            readOnly: false
                            type: string
                          deviatingJournalSeries:
                            example: Afwijking1
                            nullable: true
                            readOnly: false
                            type: string
                          financialYear:
                            example: 2023
                            format: int32
                            nullable: true
                            readOnly: false
                            type: integer
                          includeCostCenter:
                            description: Indicates whether cost centers are included in the journal.
                            example: true
                            nullable: true
                            readOnly: false
                            type: boolean
                          includeCostUnit:
                            description: Indicates whether cost units are included in the journal.
                            example: false
                            nullable: true
                            readOnly: false
                            type: boolean
                          journalCode:
                            example: "2"
                            nullable: true
                            readOnly: false
                            type: string
                          journalNumber:
                            example: 2
                            format: int32
                            nullable: true
                            readOnly: false
                            type: integer
                          linkCostCenterToGroup:
                            description: |
                              The Group to which the CostCenter will be linked.
                            example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                            format: uuid
                            nullable: true
                            pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                            readOnly: false
                            type: string
                          linkCostUnitToGroup:
                            description: |
                              The Group to which the CostUnit will be linked.
                            example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                            format: uuid
                            nullable: true
                            pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                            readOnly: false
                            type: string
                          period:
                            description: the period to which the journal should be added.
                            example: 2
                            format: int32
                            nullable: true
                            readOnly: false
                            type: integer
                          subAdministration:
                            description: The subadministration in the journalapplication to which the journal will be added.
                            nullable: true
                            properties:
                              Id:
                                example: 223
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              Name:
                                example: Administration A
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          user:
                            example: User1
                            nullable: true
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Send the journal run
      tags:
        - Journal run
  /providers/employers/payrolladministrations/payrollruns:
    patch:
      description: |
        __Activity name :__ PatchPayrollrunsByPayrollRunIds

        This action may only be performed succesfully of the following requirements are met;
        * The payroll run is ready for approval (status 1)

        Update the status of one or more payrollruns
      operationId: PatchPayrollrunsByPayrollRunIds
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll run
                    enum:
                      - confirm
                      - cancel
                    nullable: false
                    readOnly: false
                    type: string
                  id:
                    description: The unique identifier (GUID/UUID) of the payroll run.
                    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: array
        description: The request body contains an array of objects containing a `payrollrunId` and a `status` field.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the status of payrollruns
      tags:
        - Review payroll run
  "/providers/employers/payrolladministrations/payrollruns/notes/{noteId}":
    delete:
      description: |
        __Activity name :__ DeletePayrollRunNoteByNoteId

        Delete an existing note record
      operationId: DeletePayrollRunNoteByNoteId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: noteId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payroll run note record
      tags:
        - Payroll run notes
    get:
      description: |
        __Activity name :__ GetPayrollRunNoteByNoteId

        Get the details of a note
      operationId: GetPayrollRunNoteByNoteId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: noteId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            accessibleBy:
                              description: |
                                Indicates who can view this node.
                              nullable: false
                              properties:
                                key:
                                  description: The key for accessible by
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: Description of the accessible by
                                  example: Everyone
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            createdBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            createdOn:
                              description: |
                                The date on which the note was created
                              example: 2018-01-01
                              format: date-time
                              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
                            lastModifiedBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            lastModifiedOn:
                              description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                              example: 2018-01-01
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            note:
                              description: |-
                                The note it self.

                                __Note:__ This is a free text field so users can add htlm/script etc.
                              example: Remember to do xyz
                              maxLength: 4000
                              nullable: true
                              readOnly: false
                              type: string
                            subject:
                              description: subject of the note
                              example: Remember to do xyz
                              maxLength: 250
                              nullable: false
                              readOnly: false
                              type: string
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payroll run note
      tags:
        - Payroll run notes
    put:
      description: |
        __Activity name :__ PutPayrollRunNoteByNoteId

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.
      operationId: PutPayrollRunNoteByNoteId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: noteId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                accessibleBy:
                  description: |
                    Indicates who can view this node.
                  nullable: false
                  properties:
                    key:
                      description: The key for accessible by
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: Description of the accessible by
                      example: Everyone
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                createdBy:
                  format: metadata
                  nullable: true
                  properties:
                    formattedName:
                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                createdOn:
                  description: |
                    The date on which the note was created
                  example: 2018-01-01
                  format: date-time
                  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
                lastModifiedBy:
                  format: metadata
                  nullable: true
                  properties:
                    formattedName:
                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                lastModifiedOn:
                  description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                  example: 2018-01-01
                  format: date-time
                  nullable: false
                  readOnly: true
                  type: string
                note:
                  description: |-
                    The note it self.

                    __Note:__ This is a free text field so users can add htlm/script etc.
                  example: Remember to do xyz
                  maxLength: 4000
                  nullable: true
                  readOnly: false
                  type: string
                subject:
                  description: subject of the note
                  example: Remember to do xyz
                  maxLength: 250
                  nullable: false
                  readOnly: false
                  type: string
              type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          accessibleBy:
                            description: |
                              Indicates who can view this node.
                            nullable: false
                            properties:
                              key:
                                description: The key for accessible by
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: Description of the accessible by
                                example: Everyone
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          createdBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          createdOn:
                            description: |
                              The date on which the note was created
                            example: 2018-01-01
                            format: date-time
                            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
                          lastModifiedBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          lastModifiedOn:
                            description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                            example: 2018-01-01
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          note:
                            description: |-
                              The note it self.

                              __Note:__ This is a free text field so users can add htlm/script etc.
                            example: Remember to do xyz
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          subject:
                            description: subject of the note
                            example: Remember to do xyz
                            maxLength: 250
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit a payroll run note record
      tags:
        - Payroll run notes
  "/providers/employers/payrolladministrations/payrollruns/sepafiles/{sepafileId}":
    get:
      description: |-
        __Activity name :__ GetSepaFileBySepaFileId

        Returns the specified SEPA payments file as a XML file.
      operationId: GetSepaFileBySepaFileId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: Sepa file ID
          in: path
          name: sepafileId
          required: true
          schema:
            format: uuid
            type: string
        - description: |-
            Indicates the type of payment for the SEPA file.
            In case salary is selected the following will be included in the SEPA xml file
            ```
              <CtgyPurp>
                <Cd>SALA</Cd>
              </CtgyPurp>
            ```
          in: query
          name: paymentType
          schema:
            default: Salary
            enum:
              - Other
              - Salary
            type: string
        - description: |
            Determines whether the Batch Booking \<BtchBookg\> tag is included in the SEPA file and if it is which value it is set to.  By defualt this value is set to Exclude.

            Possible values for this parameter are:
            - Exclude: Do not include \<BtchBookg\> tag in SEPA file
            - IncludeTrue: Include \<BtchBookg\> tag in SEPA file and set it to 'True'
            - IncludeFalse: Include \<BtchBookg\> tag in SEPA file and set it to 'False'
          in: query
          name: batchBooking
          schema:
            default: BtchBookgExclude
            enum:
              - BtchBookgExclude
              - BtchBookgTrue
              - BtchBookgFalse
            type: string
        - description: This value is used when creating the sepa file to set the value of \<ReqdExctnDt\>
          in: query
          name: requestedExecutionDate
          required: true
          schema:
            format: date
            type: string
      responses:
        "200":
          content:
            application/xml:
              schema:
                format: binary
                type: string
          description: OK
          headers:
            Content-Disposition:
              description: |
                The filename. Explanation of the components of the filename -\> SEPA_Clientnumber_year_payrollperiod_description
              schema:
                example: inline; filename="SEPA_568_2018_2_SALARISBETALING PERIODE 2.XML"
                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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download a SEPA file
      tags:
        - Payroll run downloads
  "/providers/employers/payrolladministrations/payrollruns/{payrollrunId}":
    get:
      description: |
        __Activity name :__ GetPayrollRunByPayrollRunId

        Get the details of a single payrollrun
      operationId: GetPayrollRunByPayrollRunId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll run
          in: path
          name: payrollrunId
          required: true
          schema:
            format: uuid
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          approvalTime:
                            description: The time at which the payroll run was approved by the user
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          approvedBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          availableForEmployeeDate:
                            description: The date on which the pay slips will be available to employees.
                            example: 2018-05-08
                            format: date
                            nullable: true
                            readOnly: false
                            type: string
                          errorsAndWarnings:
                            nullable: false
                            properties:
                              hasErrors:
                                description: Indicates whether the payrollrun has errors
                                nullable: false
                                readOnly: true
                                type: boolean
                              hasWarnings:
                                description: Indicates whether the payrollrun has warnings
                                example: true
                                nullable: false
                                readOnly: true
                                type: boolean
                            readOnly: true
                            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
                          methodOfCreation:
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: The key indicating how the payroll run was created.
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                description: The value describing how the payroll run was created.
                                example: Individueel
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          payrollPeriod:
                            format: metadata
                            properties:
                              periodEndDate:
                                description: The last day of the period for which the tax return message was created
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: The period number of the payroll period the record relates to
                                example: 1
                                format: int32
                                nullable: true
                                readOnly: false
                                type: integer
                              periodStartDate:
                                description: The first day of the period for which the tax return message was created
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              testYear:
                                description: |-
                                  Indicates whether the payroll periode is part of a test year.

                                  In Loket it is possible to run a year of a payrolladministration as a so-called test year.  This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. 
                                  Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
                                example: false
                                nullable: false
                                readOnly: true
                                type: boolean
                              year:
                                description: The year of the payroll period the record relates to
                                example: 2017
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          payrollRunStatus:
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: The key indicating the current status of the payroll run.
                                example: 9
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                description: |
                                  The value describing the current status of the payroll run.
                                  * Staat klaar voor verloning. (key = 0)
                                  * Verloning gereed. (key = 1)
                                  * Proforma verloning gereed. (key = 2)
                                  * Verwijderd door gebruiker (key = 5)
                                  * Verloning geannuleerd door gebruiker. (key = 6)
                                  * Fout tijdens verloning. (key = 7)
                                  * Geen loonresultaten, verloning geannuleerd. (key = 8)
                                  * Verloning goedgekeurd. (key = 9)
                                example: Verloning goedgekeurd.
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          processingFinishedTime:
                            description: Date-time when the calculations of the wages was finished
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          removeTime:
                            description: The time at which the pay roll run was removed.
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          removedBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          requestTime:
                            description: The time at which the payroll run was requested by the user
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          requestedBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          sendEmailToEmployee:
                            description: Indicates whether an email should be sent to the employees when the pay slip is available to them.
                            nullable: false
                            readOnly: false
                            type: boolean
                          sequenceNumber:
                            description: An incremental number with a payrolling year to uniquely identify a payroll run. Null can be returned for those runs that dont contain "wages".
                            example: 1
                            format: int32
                            nullable: true
                            readOnly: true
                            type: integer
                          sequenceNumberApproved:
                            description: An incremental number with a payrolling year to uniquely identify an approved payroll run.
                            format: int32
                            nullable: true
                            readOnly: true
                            type: integer
                          textPaySlip:
                            description: An optional text provided by an authorized user that will be displayed on the pay slip.
                            maxLength: 25
                            nullable: true
                            readOnly: false
                            type: string
                          textPayment:
                            description: An optional text provided by an authorized user that will be displayed as a description for the payment.
                            maxLength: 32
                            nullable: true
                            readOnly: false
                            type: string
                          textTariffPaySlip:
                            description: An additional text to  be displayed on the tariff payslip.
                            maxLength: 25
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payrollrun
      tags:
        - Payroll run
  "/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/BalanceSheet":
    get:
      description: |
        __Activity name :__ GetPayrollRunBalanceSheetByPayrollRunId

        This endpoint returns per payroll components, marked as relevant for the general ledge (balance sheet), the sum of the values.

        If for the given payroll period of the payroll run a "journal profile" is configured the endpoint also returns the ledger account and costcenter/costunit linked to the given payroll component in the "journal profile"
      operationId: GetPayrollRunBalanceSheetByPayrollRunId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll run
          in: path
          name: payrollrunId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            journalAllocation:
                              description: |-
                                If configured in the software (by configuring a "journal profile") this array returns all the combinations of `generalLedgerAccount`, `costCenter` and `costUnit` configures for the given component.
                                The hour or factor based allocation is ignored in this endpoint.
                              items:
                                properties:
                                  costCenter:
                                    format: metadata
                                    nullable: false
                                    properties:
                                      code:
                                        description: |
                                          The code of the cost center
                                        example: SAL
                                        maxLength: 20
                                        nullable: true
                                        readOnly: true
                                        type: string
                                      key:
                                        description: |
                                          The key of the cost center
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        description: |
                                          The description of the cost center
                                        example: Sales
                                        maxLength: 50
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                  costUnit:
                                    format: metadata
                                    properties:
                                      code:
                                        description: |
                                          The code of the cost unit
                                        example: INT
                                        maxLength: 20
                                        nullable: true
                                        readOnly: true
                                        type: string
                                      key:
                                        description: |
                                          The key of the cost unit
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        description: |
                                          The description of the cost unit
                                        example: International
                                        maxLength: 50
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                  generalLedgerAccount:
                                    format: metadata
                                    nullable: false
                                    properties:
                                      generalLedgerAccountnumber:
                                        description: |
                                          The account number for the general ledger account
                                        example: 4001
                                        maxLength: 20
                                        nullable: false
                                        readOnly: true
                                        type: string
                                      key:
                                        description: |
                                          The key of the general ledger account
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        description: |
                                          The description of the general ledger account
                                        example: Wages
                                        maxLength: 50
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                              minItems: 0
                              nullable: false
                              type: array
                            payrollComponent:
                              description: |
                                A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                                `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                              format: metadata
                              properties:
                                balanceSheetSide:
                                  format: metadata
                                  properties:
                                    key:
                                      description: |
                                        Indicates on what side (debit or credit) the value should go
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      description: |
                                        The description of the side of the balance sheet
                                      example: Credit
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                description:
                                  description: |
                                    The description of the payroll component
                                  example: Wage
                                  maxLength: 14
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  description: |
                                    The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart.
                                  example: 70
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            value:
                              description: |-
                                The sum of all the values for the payrollcomponent in the specific payroll run. 
                                Payroll period, employment and normal/tarif payslip are not taken into account and simply summed up.
                              example: 40457.01
                              nullable: false
                              readOnly: true
                              type: number
                          type: object
                        type: array
                    type: object
            text/csv:
              schema:
                description: The output in CSV
                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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payroll run balance sheet
      tags:
        - Payroll run downloads
  "/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/defaultset":
    get:
      description: |
        Returns the default set of downloads for the payroll run as a PDF file. The default set of downloads can be defined by the user.
      operationId: GetDefaultSetByPayrollRunId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll run
          in: path
          name: payrollrunId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download the default set of downloads for a payroll run
      tags:
        - Payroll run downloads
  "/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/errorsandwarnings":
    get:
      description: |
        __Activity name :__ GetErrorsAndWarningsByPayrollRunId

        Returns an overview of errors and warnings that occurred during the payroll run as a PDF file.
      operationId: GetErrorsAndWarningsByPayrollRunId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll run
          in: path
          name: payrollrunId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download errors and warnings for a payroll run
      tags:
        - Payroll run downloads
  "/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/journalentriesperdistributionunitoverviews":
    get:
      description: |
        __Activity name :__ GetJournalEntriesPerDistributionUnitOverviewsByPayrollRunId

        Returns the journal entries by distribution Unit for a payroll run as a PDF file.
      operationId: GetJournalEntriesPerDistributionUnitOverviewsByPayrollRunId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll run
          in: path
          name: payrollrunId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download the journal entries by distribution Unit.
      tags:
        - Payroll run downloads
  "/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/notes":
    get:
      description: |
        __Activity name :__ GetPayrollRunNotesByPayrollRunId

        Get a list of notes, available for the user, for the payroll run. 
      operationId: GetPayrollRunNotesByPayrollRunId
      parameters:
        - description: The unique identifier of the payroll run
          in: path
          name: payrollrunId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            accessibleBy:
                              description: |
                                Indicates who can view this node.
                              nullable: false
                              properties:
                                key:
                                  description: The key for accessible by
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: Description of the accessible by
                                  example: Everyone
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            createdBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            createdOn:
                              description: |
                                The date on which the note was created
                              example: 2018-01-01
                              format: date-time
                              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
                            lastModifiedBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            lastModifiedOn:
                              description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                              example: 2018-01-01
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            note:
                              description: |-
                                The note it self.

                                __Note:__ This is a free text field so users can add htlm/script etc.
                              example: Remember to do xyz
                              maxLength: 4000
                              nullable: true
                              readOnly: false
                              type: string
                            subject:
                              description: subject of the note
                              example: Remember to do xyz
                              maxLength: 250
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 notes for a payroll run.
      tags:
        - Payroll run notes
    post:
      description: |
        __Activity name :__ PostPayrollRunNoteByPayrollRunId

        __Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.

        __Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostPayrollRunNoteByPayrollRunId
      parameters:
        - description: The unique identifier of the payroll run
          in: path
          name: payrollrunId
          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 <TOKEN>
            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:
                accessibleBy:
                  description: |
                    Indicates who can view this node.
                  nullable: false
                  properties:
                    key:
                      description: The key for accessible by
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: Description of the accessible by
                      example: Everyone
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                createdBy:
                  format: metadata
                  nullable: true
                  properties:
                    formattedName:
                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                createdOn:
                  description: |
                    The date on which the note was created
                  example: 2018-01-01
                  format: date-time
                  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
                lastModifiedBy:
                  format: metadata
                  nullable: true
                  properties:
                    formattedName:
                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                lastModifiedOn:
                  description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                  example: 2018-01-01
                  format: date-time
                  nullable: false
                  readOnly: true
                  type: string
                note:
                  description: |-
                    The note it self.

                    __Note:__ This is a free text field so users can add htlm/script etc.
                  example: Remember to do xyz
                  maxLength: 4000
                  nullable: true
                  readOnly: false
                  type: string
                subject:
                  description: subject of the note
                  example: Remember to do xyz
                  maxLength: 250
                  nullable: false
                  readOnly: false
                  type: string
              type: object
        description: Add a note
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          accessibleBy:
                            description: |
                              Indicates who can view this node.
                            nullable: false
                            properties:
                              key:
                                description: The key for accessible by
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: Description of the accessible by
                                example: Everyone
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          createdBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          createdOn:
                            description: |
                              The date on which the note was created
                            example: 2018-01-01
                            format: date-time
                            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
                          lastModifiedBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          lastModifiedOn:
                            description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                            example: 2018-01-01
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          note:
                            description: |-
                              The note it self.

                              __Note:__ This is a free text field so users can add htlm/script etc.
                            example: Remember to do xyz
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          subject:
                            description: subject of the note
                            example: Remember to do xyz
                            maxLength: 250
                            nullable: false
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 note for a payroll run
      tags:
        - Payroll run notes
  "/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/paymentoverviews":
    get:
      description: |
        __Activity name :__ GetPaymentOverviewsByPayrollRunId

        Returns payment overviews for a payroll run as a PDF file. By default the payment overview 1 is returned.
      operationId: GetPaymentOverviewsByPayrollRunId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll run
          in: path
          name: payrollrunId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download payment overviews for a payroll run
      tags:
        - Payroll run downloads
  "/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/payrollcontrolregister":
    get:
      description: |
        __Activity name :__ GetPayrollControlRegisterByPayrollRunId

        Returns payroll control register for a payroll run as a PDF file.
      operationId: GetPayrollControlRegisterByPayrollRunId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll run
          in: path
          name: payrollrunId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download payroll control register for a payroll run
      tags:
        - Payroll run downloads
  "/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/payslips":
    get:
      description: |
        __Activity name :__ GetPayslipsByPayrollRunId


        Returns the payslips for a payroll run as a PDF file. By default the payslips are sorted by `employeeNumber`.
      operationId: GetPayslipsByPayrollRunId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll run
          in: path
          name: payrollrunId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download payslips for a payroll run
      tags:
        - Payroll run downloads
  "/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/results":
    get:
      description: |
        __Activity name :__ GetPayrollRunResultsByPayrollRunId  

        Returns the results for the payroll run
      operationId: GetPayrollRunResultsByPayrollRunId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll run
          in: path
          name: payrollrunId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            employmentId:
                              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
                            payrollPeriods:
                              items:
                                properties:
                                  payrollPeriod:
                                    format: metadata
                                    properties:
                                      periodEndDate:
                                        description: The last day of the period for which the tax return message was created
                                        example: 2018-01-31
                                        format: date
                                        nullable: false
                                        readOnly: true
                                        type: string
                                      periodNumber:
                                        description: The period number of the payroll period the record relates to
                                        example: 1
                                        format: int32
                                        nullable: true
                                        readOnly: false
                                        type: integer
                                      periodStartDate:
                                        description: The first day of the period for which the tax return message was created
                                        example: 2018-01-01
                                        format: date
                                        nullable: false
                                        readOnly: true
                                        type: string
                                      testYear:
                                        description: |-
                                          Indicates whether the payroll periode is part of a test year.

                                          In Loket it is possible to run a year of a payrolladministration as a so-called test year.  This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. 
                                          Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
                                        example: false
                                        nullable: false
                                        readOnly: true
                                        type: boolean
                                      year:
                                        description: The year of the payroll period the record relates to
                                        example: 2017
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                    type: object
                                  payslipTypes:
                                    items:
                                      properties:
                                        payrollComponentResults:
                                          items:
                                            properties:
                                              payrollComponent:
                                                description: |
                                                  A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                                                  `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                                format: metadata
                                                properties:
                                                  category:
                                                    description: |
                                                      The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.    
                                                    format: metadata
                                                    nullable: false
                                                    properties:
                                                      key:
                                                        example: 1
                                                        format: int32
                                                        nullable: false
                                                        readOnly: true
                                                        type: integer
                                                      value:
                                                        example: Uren
                                                        nullable: false
                                                        readOnly: true
                                                        type: string
                                                    readOnly: true
                                                    type: object
                                                  column:
                                                    description: |
                                                      The wage sheet column (kolom) of the payroll component. Kolommen are related to its specific lines on the payslip and/or wage sheet.  Also this does bear some similiarties to wage sheets columns (loonstaatkolommen) used by the Belastingdienst, however the division of columns as used by Loket is not identical to that.
                                                    format: metadata
                                                    nullable: false
                                                    properties:
                                                      key:
                                                        example: 6
                                                        format: int32
                                                        nullable: false
                                                        readOnly: true
                                                        type: integer
                                                      value:
                                                        example: Sociaalplichtig loon
                                                        nullable: false
                                                        readOnly: true
                                                        type: string
                                                    readOnly: true
                                                    type: object
                                                  costsEmployer:
                                                    description: |
                                                      Indicates whether the components are costs for the employer (+) or negative costs (-, i.e. benefit) for the employer. The value could also be NULL meaning that the component is not related to actual expenses.
                                                    format: metadata
                                                    nullable: true
                                                    properties:
                                                      key:
                                                        example: 1
                                                        format: int32
                                                        nullable: false
                                                        readOnly: true
                                                        type: integer
                                                      value:
                                                        example: +
                                                        nullable: false
                                                        readOnly: true
                                                        type: string
                                                    readOnly: true
                                                    type: object
                                                  key:
                                                    description: |
                                                      The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart.
                                                    example: 1
                                                    format: int32
                                                    nullable: false
                                                    readOnly: false
                                                    type: integer
                                                  value:
                                                    description: |
                                                      The description of the payroll component
                                                    example: Uren gewerkt
                                                    maxLength: 14
                                                    nullable: false
                                                    readOnly: true
                                                    type: string
                                                type: object
                                              value:
                                                description: Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this.
                                                example: 40
                                                nullable: false
                                                readOnly: true
                                                type: number
                                              valueSpecialTariff:
                                                description: Value/ amount (speciaal tarief voor belasting) for the payrollcomponent. Both a 'normal' and 'special tariff' type payslip may a value for this. Also, both valueNormal and valueSpecialTariff may have a value at the same time.
                                                example: 144
                                                nullable: false
                                                readOnly: true
                                                type: number
                                            type: object
                                          type: array
                                        payslipType:
                                          description: |
                                            The type of payslip on which underlying payroll run results will be booked. This is either normaal or bijzonder tarief.
                                          format: metadata
                                          nullable: false
                                          properties:
                                            key:
                                              example: 1
                                              format: int32
                                              nullable: false
                                              readOnly: true
                                              type: integer
                                            value:
                                              example: Normaal strook
                                              nullable: false
                                              readOnly: true
                                              type: string
                                          readOnly: true
                                          type: object
                                      type: object
                                    type: array
                                type: object
                              type: array
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 results for a payroll run
      tags:
        - Payroll run results
  "/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/runoverviews":
    get:
      description: |
        __Activity name :__ GetRunOverviewsByPayrollRunId

        Returns run overviews for a payroll run as a PDF file.
      operationId: GetRunOverviewsByPayrollRunId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll run
          in: path
          name: payrollrunId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download run overviews for a payroll run
      tags:
        - Payroll run downloads
  "/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/sepafiles":
    get:
      description: |-
        __Activity name :__ GetSepaFilesByPayrollRunId

        Returns the SEPA file(s) for the specified payroll run.
      operationId: GetSepaFilesByPayrollRunId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll run
          in: path
          name: payrollrunId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/json;version=2018-01-01:
              schema:
                items:
                  properties:
                    description:
                      description: Description of the sepa file
                      example: SALARISBETALING PERIODE 9
                      maxLength: 32
                      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: array
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 a list of SEPA files for a payroll run
      tags:
        - Payroll run downloads
  "/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/totalsepafile":
    get:
      description: |-
        __Activity name :__ GetTotalSepaFileByPayrollRunId

        Returns the total SEPA payments file as a XML file. This file contains the payments of all the available SEPA payment files available for the specified payroll run.
      operationId: GetTotalSepaFileByPayrollRunId
      parameters:
        - description: The unique identifier of the payroll run
          in: path
          name: payrollrunId
          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 <TOKEN>
            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: |-
            Indicates the type of payment for the SEPA file.
            In case salary is selected the following will be included in the SEPA xml file
            ```
              <CtgyPurp>
                <Cd>SALA</Cd>
              </CtgyPurp>
            ```
          in: query
          name: paymentType
          schema:
            default: Salary
            enum:
              - Other
              - Salary
            type: string
        - description: |
            Determines whether the Batch Booking \<BtchBookg\> tag is included in the SEPA file and if it is which value it is set to.  By defualt this value is set to Exclude.

            Possible values for this parameter are:
            - Exclude: Do not include \<BtchBookg\> tag in SEPA file
            - IncludeTrue: Include \<BtchBookg\> tag in SEPA file and set it to 'True'
            - IncludeFalse: Include \<BtchBookg\> tag in SEPA file and set it to 'False'
          in: query
          name: batchBooking
          schema:
            default: BtchBookgExclude
            enum:
              - BtchBookgExclude
              - BtchBookgTrue
              - BtchBookgFalse
            type: string
        - description: This value is used when creating the sepa file to set the value of \<ReqdExctnDt\>
          in: query
          name: requestedExecutionDate
          required: true
          schema:
            format: date
            type: string
      responses:
        "200":
          content:
            application/xml:
              schema:
                format: binary
                type: string
          description: OK
          headers:
            Content-Disposition:
              description: |
                The filename. Explanation of the components of the filename -\> SEPA_Clientnumber_year_payrollperiod_description
              schema:
                example: inline; filename="SEPA_569_2018_1_TOTAAL.XML"
                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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download a total SEPA file
      tags:
        - Payroll run downloads
  "/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/undo":
    post:
      description: |-
        __Activity name :__ UndoPayrollRunByPayrollRunId This is a controller endpoint to perform an action.

        In the older Loket GUI this specific action is referred to as 'Verwijderen loonrun' If this action is performed succesfully then the payroll run will be 'deleted' in the sense that its results will be undone. Please note that situations where an approved payroll run would have to be 'undone' should be generally be avoided. Preferably any mistakes or consistencies should be picked out at an earlier stage in the payroll process.

        This action may only be performed succesfully of the following requirements are met;

        * The payroll run is the very last payroll run that has been approved within this payroll administration
        * It is not possible to undo a  payroll run if there is currently a payroll run with status 0  (to be processed) or 1 (awaiting approval) within the payroll administation.
        * Additionally, no related (external) information should still be present for the given payroll run. This will be validated by the endpoint.

        __Metadata :__  No metadata endpoint available for this controller endpoint.

        __Defaults :__ No defaults endpoint available for this controller endpoint.
      operationId: UndoPayrollRunByPayrollRunId
      parameters:
        - description: The unique identifier of the payroll run
          in: path
          name: payrollrunId
          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 <TOKEN>
            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:
        "201":
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Undo payroll run (verwijderen loonrun)
      tags:
        - Undo payroll run
  "/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/wagesheets":
    get:
      description: |
        __Activity name :__ GetWageSheetsByPayrollRunId

        Returns the wage sheets for a payroll run as a PDF file or XLSX file. By default the wage sheets contain information on both the employer and the employees.
      operationId: GetWageSheetsByPayrollRunId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll run
          in: path
          name: payrollrunId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download wage sheets for a payroll run
      tags:
        - Payroll run downloads
  /providers/employers/payrolladministrations/payrolltaxreturns:
    patch:
      description: |
        __Activity name :__ PatchPayrollTaxReturnsByPayrollTaxReturnIds

        This endpoints changes the status of the list of the payroll tax returns provided in the request body based on the provided action.
      operationId: PatchPayrollTaxReturnsByPayrollTaxReturnIds
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll tax return
                    enum:
                      - confirm
                      - cancel
                    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: |
          The request body contains an array of objects containing a `PayrolTaxReturnId` and a `taxReturnMessageStatus`
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the status of payroll tax returns
      tags:
        - Payroll tax return
  "/providers/employers/payrolladministrations/payrolltaxreturns/{messageReference}":
    patch:
      description: |
        __Activity name :__ PatchPayrollTaxReturnByMessageReference

        This endpoints changes the status of the payroll tax returns provided in the path parameters based on the provided action.

        Functionally, this endpoint is very similar to PatchPayrollTaxReturnsByPayrollTaxReturnIds endpoint,  however this endpoint takes the messageReference (NL: BERICHTKENMERK) as path id. Instead of payrollTaxReturnId (GUID). AND, in contrast, this endpoint is a SINGLE PATCH endpoint which consumes a path id.  
      operationId: PatchPayrollTaxReturnByMessageReference
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll tax return
          in: path
          name: messageReference
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                action:
                  description: The action to perform on the payroll tax return
                  enum:
                    - confirm
                    - cancel
                  nullable: false
                  readOnly: false
                  type: string
              required:
                - action
              type: object
        description: |
          The request body contains an action
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the status of payroll tax returns
      tags:
        - Payroll tax return by message reference
  "/providers/employers/payrolladministrations/payrolltaxreturns/{messageReference}/sendresponsemessagebymessagereference":
    post:
      description: |
        __Activity name :__ PostSendResponseMessageByMessageReference

        This endpoint is identical to PostSendResponseMessageByPayrollTaxReturnId endpoint,  however this endpoint takes the messageReference (NL: BERICHTKENMERK) as path id. Instead of payrollTaxReturnId (GUID).  
      operationId: PostSendResponseMessageByMessageReference
      parameters:
        - description: The unique identifier of the payroll tax return
          in: path
          name: messageReference
          required: true
          schema:
            type: string
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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:
              properties:
                responseMessageFile:
                  description: base64 encoded xml file of the response message
                  example: PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iSVNPLTg4NTktMSI/Pgo8UmVzcG9uc2VtZXNzYWdlIHZlcnNpb249IjIwMDYuMSI+Cgk8SWRlbnRpZmljYXRpb24+CgkJPE1lc3NhZ2VJZD5BLWVmMmJmMTQwMjMxYzExZTA4MWM5MGE5ZTA0MGIxMjM0PC9NZXNzYWdlSWQ+CgkJPFJlZmVyc1RvTWVzc2FnZUlkPlZTUDAwMTAwMTE4MzcyMkwwNDAwMDAwMTIwMTIzNDwvUmVmZXJzVG9NZXNzYWdlSWQ+CgkJPE1lc3NhZ2VJZEJkPmVmMmJmMTQwMjMxYzExZTA4MWM5MGE5ZTA0MGIxMjM0PC9NZXNzYWdlSWRCZD4KCQk8RGF0dW1UaWpkT250dmFuZ3N0PjIwMjAtMDEtMThUMTY6MDY6MzlaPC9EYXR1bVRpamRPbnR2YW5nc3Q+CgkJPFJlc3BvbnNlVHlwZT5hY2tub3dsZWRnZW1lbnQ8L1Jlc3BvbnNlVHlwZT4KCTwvSWRlbnRpZmljYXRpb24+CjwvUmVzcG9uc2VtZXNzYWdlPgo
                  nullable: false
                  readOnly: false
                  type: string
              type: object
        description: The request body contains the xml response message
        required: true
      responses:
        "202":
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Send the response message for the payroll tax return
      tags:
        - Payroll tax return by message reference
  "/providers/employers/payrolladministrations/payrolltaxreturns/{payrolltaxreturnId}":
    get:
      description: |
        __Activity name :__ GetPayrollTaxReturnByPayrollTaxReturnId

        The details of a tax return for an administration
      operationId: GetPayrollTaxReturnByPayrollTaxReturnId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll tax return
          in: path
          name: payrolltaxreturnId
          required: true
          schema:
            format: uuid
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          approvalTime:
                            description: The time at which the payroll tax return run was approved by the user
                            example: 2021-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          approvedBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          cancelledBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          cancelledTime:
                            description: The time at which the pay roll run was cancelled. (Annuleren)
                            example: 2021-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          correctionAmount:
                            description: The amount, in euro's, of wage tax to be paid as correction for previous period(s)
                            example: 500
                            nullable: false
                            readOnly: true
                            type: number
                          deadlineForPayment:
                            description: The final date at which the amount is due.
                            example: 2021-12-31
                            format: date
                            nullable: false
                            readOnly: true
                            type: string
                          emailAddressPayrollTaxReturnRunStarted:
                            description: The e-mail address to which an email will be sent when the payroll tax return run is started. (Email starten)
                            example: info@loket.nl
                            nullable: true
                            readOnly: true
                            type: string
                          externalIdentification:
                            description: An identifier to be filled by external parties after submitting the tax return.
                            example: AA123
                            nullable: true
                            readOnly: true
                            type: string
                          iban:
                            description: The IBAN to which the payroll tax return should be payed. Only IBAN without spaces are accepted.
                            example: NL86INGB0002445588
                            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
                          inTheNameOf:
                            description: The name of the benificiary corresponding with the IBAN
                            example: tnv belastingdienst Apeldoorn
                            nullable: false
                            readOnly: true
                            type: string
                          isCorrectionMessagePriorYear:
                            description: |
                              Indicates whether the payroll tax return is a correction message or not. A correction message is always for a prior year and no SEPA file can be downloaded for a correction message.  
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          messageCreationTime:
                            description: Date-time when the message was created
                            example: 2021-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          messageReference:
                            description: |
                              The message reference (berichtkenmerk) that is used within the payroll tax return message.
                            example: VSP001111111110L29000035201302
                            nullable: false
                            readOnly: true
                            type: string
                          methodOfCreation:
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: The key indicating how the payroll tax return run was created.
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                description: The value describing how the payroll tax return run was created.
                                example: Individueel
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          paymentReference:
                            description: The payment reference (betalingskenmerk) to be used when making the payment to the tax office.
                            example: "8111111116529080"
                            nullable: false
                            readOnly: true
                            type: string
                          payrollPeriodType:
                            description: Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4).
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: month
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          payrollTaxReturnParty:
                            description: Indicates the party submitting the tax return.
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Loket.nl
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          payrollTaxReturnStatus:
                            description: |
                              The current status of the tax return
                              Possible values:

                              * Verzoek tot aanmaak loonaangifte (key = 1)
                              * Fout bij aanmaken loonaangifte (key = 2)
                              * Loonaangifte aangemaakt (key = 3)
                              * Loonaangifte geannuleerd (key = 4)
                              * Loonaangifte bevestigd (key = 5)
                              * Loonaangifte verzonden (key = 6)
                              * Loonaangifte verwijderd (key = 7)
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 3
                                format: int32
                                type: integer
                              value:
                                example: Loonaangifte aangemaakt
                                type: string
                            readOnly: true
                            type: object
                          payrollTaxReturnType:
                            description: Indicates the frequence of the payrol tax retun process. Can be each payroll period or annually.
                            nullable: false
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Periodeaangifte
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          period:
                            format: metadata
                            properties:
                              periodEndDate:
                                description: The last day of the period for which the tax return message was created
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: The period number of the payroll period for which the tax return was created. In case of a yearly tax return this value will be set to 0
                                example: 1
                                format: int32
                                nullable: true
                                readOnly: true
                                type: integer
                              periodStartDate:
                                description: The first day of the period for which the tax return message was created
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              year:
                                description: The year of the period for which the tax return message was created.
                                example: 2017
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                            type: object
                          periodAmount:
                            description: The amount, in euro's, of wage tax to be paid for this period
                            example: 2000
                            nullable: false
                            readOnly: true
                            type: number
                          processingFinishedTime:
                            description: Date-time when the calculations were finished
                            example: 2021-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          removalTime:
                            description: The time at which the payroll tax return run was removed (verwijderd by the user
                            example: 2021-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          removedBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          requestTime:
                            description: The time at which the payroll tax return run was requested by the user
                            example: 2021-05-08T15:16:49+02:00
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          requestedBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          responseMessages:
                            items:
                              properties:
                                dateOfReceipt:
                                  description: The date on which the response message was received
                                  example: 2016-01-19
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                responseClass:
                                  description: The Walvis class code
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 26
                                      format: int32
                                      type: integer
                                    value:
                                      example: Loonheffingennummer is onjuist
                                      type: string
                                  readOnly: true
                                  type: object
                                responseType:
                                  description: The response type
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      type: integer
                                    value:
                                      example: Error
                                      type: string
                                  readOnly: true
                                  type: object
                              type: object
                            type: array
                          sendTime:
                            description: The time at which the payroll tax return run message was send.
                            example: 2021-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          sequenceNumber:
                            description: An incremental number.
                            example: 1
                            format: int32
                            nullable: false
                            readOnly: true
                            type: integer
                          taxReturnMessageReference:
                            description: The name of the party responsible for the payroll tax return
                            example: Bedrijf B.V.
                            nullable: true
                            readOnly: true
                            type: string
                          totalAmount:
                            description: The cumulative ammount of the correctionAmount and periodAmount. Indication the total ammount to be paid for this wagetax return
                            example: 2500
                            nullable: false
                            readOnly: true
                            type: number
                          wageTaxNumber:
                            description: The wage tax number aka Loonheffingennummer.
                            example: 111111110L00
                            maxLength: 12
                            nullable: false
                            readOnly: true
                            type: string
                          withholdingParty:
                            description: The name of the party responsible for the payroll tax return
                            example: Bedrijf B.V.
                            nullable: true
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 tax return for an administration
      tags:
        - Payroll tax return
  "/providers/employers/payrolladministrations/payrolltaxreturns/{payrolltaxreturnId}/ideal":
    get:
      description: |
        __Activity name :__ GetIdealUrlByPayrollTaxReturnId

        Get URL which allows the user to pay payroll taxes via IDEAL
      operationId: GetIdealUrlByPayrollTaxReturnId
      parameters:
        - description: The unique identifier of the payroll tax return
          in: path
          name: payrolltaxreturnId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          url:
                            description: The URL leads to the IDEAL payment environment of the dutch payroll tax authorities (belastingdienst).
                            example: https://betalen.belastingdienst.nl/kas/ideal_betaling?id=1700&code=1easdasasdasdasdasdasd5
                            format: url
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Pay payroll taxes using IDEAL
      tags:
        - Payroll tax return
  "/providers/employers/payrolladministrations/payrolltaxreturns/{payrolltaxreturnId}/idealPaymentStatus":
    get:
      description: |
        __Activity name :__ GetIdealPaymentStatusByPayrollTaxReturnId

        Get the status of the IDEAL payment
      operationId: GetIdealPaymentStatusByPayrollTaxReturnId
      parameters:
        - description: The unique identifier of the payroll tax return
          in: path
          name: payrolltaxreturnId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          lastStatusRequest:
                            description: The date time on which the last **succesful** status request was performed
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          status:
                            nullable: true
                            properties:
                              code:
                                description: The status code (as defined by the Dutch tax authorities) of the IDEAL payment
                                example: acsc
                                nullable: false
                                readOnly: true
                                type: string
                              reason:
                                description: The reason for the given status code of the IDEAL payment
                                example: accepted
                                nullable: false
                                readOnly: true
                                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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the status of the IDEAL payment
      tags:
        - Payroll tax return
  "/providers/employers/payrolladministrations/payrolltaxreturns/{payrolltaxreturnId}/message":
    get:
      description: |
        __Activity name :__ GetMessageByPayrollTaxReturnId   

        Download the message of the payroll tax return (loonaangiftebericht) in xml. Please note that this does NOT refer to the response message, but to the initial message i.e. loonaangiftebericht.
      operationId: GetMessageByPayrollTaxReturnId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll tax return
          in: path
          name: payrolltaxreturnId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/xml:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download the message of a payroll tax return
      tags:
        - Payroll tax return downloads
  "/providers/employers/payrolladministrations/payrolltaxreturns/{payrolltaxreturnId}/overview":
    get:
      description: |
        __Activity name :__ GetOverviewByPayrollTaxReturnId

        Download the payroll tax return overiew
      operationId: GetOverviewByPayrollTaxReturnId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll tax return
          in: path
          name: payrolltaxreturnId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download the overview report of a payroll tax return
      tags:
        - Payroll tax return downloads
  "/providers/employers/payrolladministrations/payrolltaxreturns/{payrolltaxreturnId}/sendresponsemessage":
    post:
      description: |
        __Activity name :__ PostSendResponseMessageByPayrollTaxReturnId

        Send the response message of the payroll tax return (loonaangifte) that was received from the Belastingdienst,  to Loket.nl . 
        This is ONLY applicable for the limited group of parties that send and receive the payroll tax return themselves to the Belastingdienst. For the purposes of having those results visible in Loket the corresponding response message can be send to Loket via this endpoint.

        What this endpoint does is the following:
        * It will receive the xml response message. For the schema (XSD) of this xml response message we refer to the documentation by the Belastingdienst itself
        * A set of input validations will be performed.
        * If those steps are succesful the xml response message will placed in a designated directory. Where it will be picked up for final processing by a proces that runs about every 15 minutes
        * In other words; the result of this action will NOT be immediately visible
      operationId: PostSendResponseMessageByPayrollTaxReturnId
      parameters:
        - description: The unique identifier of the payroll tax return
          in: path
          name: payrolltaxreturnId
          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 <TOKEN>
            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:
              properties:
                responseMessageFile:
                  description: base64 encoded xml file of the response message
                  example: PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iSVNPLTg4NTktMSI/Pgo8UmVzcG9uc2VtZXNzYWdlIHZlcnNpb249IjIwMDYuMSI+Cgk8SWRlbnRpZmljYXRpb24+CgkJPE1lc3NhZ2VJZD5BLWVmMmJmMTQwMjMxYzExZTA4MWM5MGE5ZTA0MGIxMjM0PC9NZXNzYWdlSWQ+CgkJPFJlZmVyc1RvTWVzc2FnZUlkPlZTUDAwMTAwMTE4MzcyMkwwNDAwMDAwMTIwMTIzNDwvUmVmZXJzVG9NZXNzYWdlSWQ+CgkJPE1lc3NhZ2VJZEJkPmVmMmJmMTQwMjMxYzExZTA4MWM5MGE5ZTA0MGIxMjM0PC9NZXNzYWdlSWRCZD4KCQk8RGF0dW1UaWpkT250dmFuZ3N0PjIwMjAtMDEtMThUMTY6MDY6MzlaPC9EYXR1bVRpamRPbnR2YW5nc3Q+CgkJPFJlc3BvbnNlVHlwZT5hY2tub3dsZWRnZW1lbnQ8L1Jlc3BvbnNlVHlwZT4KCTwvSWRlbnRpZmljYXRpb24+CjwvUmVzcG9uc2VtZXNzYWdlPgo
                  nullable: false
                  readOnly: false
                  type: string
              type: object
        description: The request body contains the xml response message
        required: true
      responses:
        "202":
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Send the response message for the payroll tax return
      tags:
        - Payroll tax return response message
  "/providers/employers/payrolladministrations/upapensiondeclarations/{upaPensionDeclarationId}":
    get:
      description: |
        __Activity name :__ GetUpaPensionDeclarationByUpaPensionDeclarationId

        Details of UPA pension declaration
      operationId: GetUpaPensionDeclarationByUpaPensionDeclarationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 pension declaration.
          in: path
          name: upaPensionDeclarationId
          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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          approvalTime:
                            description: The time at which the payroll run was approved by the user
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          approvedBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          cancelledBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          cancelledTime:
                            description: The time at which the payroll run was Cancelled by the user
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          creationTime:
                            description: The time at which the pension message was requested by the user
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          externalParty:
                            description: External party (externe partij)
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 13
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: PFZW (UPA)
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            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
                          messageReference:
                            description: |
                              The message reference (berichtkenmerk) to recognize the given declaration.
                            example: "190"
                            nullable: true
                            readOnly: true
                            type: string
                          methodOfCreation:
                            description: Method by which the creation of the run was triggered.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Individueel
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          payrollTaxesNumber:
                            description: The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst.
                            example: 111111110L46
                            maxLength: 12
                            minLength: 12
                            nullable: true
                            readOnly: false
                            type: string
                          period:
                            format: metadata
                            nullable: true
                            properties:
                              periodEndDate:
                                description: The end date of the period
                                example: 2021-11-30
                                format: date
                                nullable: false
                                readOnly: false
                                type: string
                              periodId:
                                description: The periodId of the payroll period.
                                example: 202101
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              periodNumber:
                                description: The period number of the payroll period for which the pension declaration was created. In case of a yearly tax return this value will be set to 0
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              periodStartDate:
                                description: The start date of the period
                                example: 2021-11-01
                                format: date
                                nullable: false
                                readOnly: false
                                type: string
                              periodType:
                                description: Indicates the frequence of the process. Payrolling can be done on a montly, 4-weekly or weekly basis.
                                nullable: true
                                properties:
                                  key:
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  value:
                                    example: month
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: true
                                type: object
                              year:
                                description: The year of the period for which the pension declaration was created.
                                example: 2017
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                            type: object
                          removeTime:
                            description: The time at which the pay roll run was removed.
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          removedBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          requestTime:
                            description: The time at which the payroll run was requested by the user
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          requestedBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          responseMessages:
                            items:
                              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: true
                                  type: string
                                code:
                                  description: The description of the response message
                                  example: NOK
                                  nullable: false
                                  readOnly: true
                                  type: string
                                datetimeOfMessageReceipt:
                                  description: The date on which the original message was received by the external entity
                                  example: 2016-01-19
                                  format: date-time
                                  nullable: false
                                  readOnly: true
                                  type: string
                                datetimeOfRegistration:
                                  description: The date on which the response message was registered in Loket
                                  example: 2016-01-19
                                  format: date-time
                                  nullable: false
                                  readOnly: true
                                  type: string
                                description:
                                  description: The description of the response message
                                  example: De werkgever heeft geen contract voor de opgegeven regeling. Doe opnieuw aangifte zonder deze regeling.
                                  nullable: false
                                  readOnly: true
                                  type: string
                                descriptionFragment:
                                  description: The description of the response message
                                  example: Het Loonheffingennummer moet bestaan, bekend en in gebruik zijn bij de PUO.
                                  nullable: false
                                  readOnly: true
                                  type: string
                                employeeNumber:
                                  description: |
                                    The employee number to uniquely identify an employee within an employer
                                  example: 156
                                  format: int32
                                  minimum: 1
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                errorType:
                                  description: If  there is an error type then this field contain its value.
                                  example: F
                                  nullable: true
                                  readOnly: true
                                  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: false
                                  readOnly: true
                                  type: integer
                                lineNumber:
                                  description: If  there is an error type then this field contain a value.
                                  example: 14
                                  nullable: true
                                  readOnly: true
                                  type: integer
                                linePosition:
                                  description: If  there is an error type then this field contain a value.
                                  example: 11
                                  nullable: true
                                  readOnly: true
                                  type: integer
                                responseStatus:
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Bericht niet OK (NOK)
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                responseType:
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Ontvangstbevestiging (ACK)
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                              type: object
                            type: array
                          sendingPartyNumber:
                            description: |
                              The number of the sending party (i.e. nummer leverancier).
                            example: SWO00077
                            nullable: false
                            readOnly: true
                            type: string
                          sentTime:
                            description: The time at which the pay roll run was sent.
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          upaPensionDeclarationStatus:
                            description: |
                              The current status of the pension declaration

                              Possible values:
                              * Verzoek tot aanmaak pensioenaangifte (key = 1)
                              * Fout bij aanmaken pensioenaangifte (key = 2)
                              * Pensioenaangifte aangemaakt (key = 3)
                              * Pensioenaangifte geannuleerd (key = 4)
                              * Pensioenaangifte bevestigd (key = 5)
                              * Pensioenaangifte verzonden (key = 6)
                              * Pensioenaangifte verwijderd (key = 7)
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 3
                                format: int32
                                type: integer
                              value:
                                example: Pensioenaangifte aangemaakt
                                type: string
                            readOnly: true
                            type: object
                          withholdingAgentName:
                            description: |
                              The withholding agent name (naam inhoudingsplichtige) for this return.
                            example: Ben-Hur BV Via Roma
                            nullable: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Detail UPA pension declaration
      tags:
        - Upa pension declaration
    patch:
      description: |
        __Activity name :__ PatchUpaPensionDeclarationByUpaPensionDeclarationId

        This endpoints changes the status of the Upa pensiondeclaration based on the provided action.
      operationId: PatchUpaPensionDeclarationByUpaPensionDeclarationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: upaPensionDeclarationId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                action:
                  description: The action to perform on the upa pensiondeclaration
                  enum:
                    - confirm
                    - cancel
                  nullable: false
                  readOnly: false
                  type: string
              required:
                - id
                - action
              type: object
        description: |
          The request body contains the action (cancel / confirm)
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the status of a upa pension declaration
      tags:
        - Upa pension declaration
  "/providers/employers/payrolladministrations/upapensiondeclarations/{upaPensionDeclarationId}/message":
    get:
      description: |
        __Activity name :__ GetMessageByUpaPensionDeclarationId  

        Download the message of the UPA pension declaration (pensioenaangiftebericht) in xml. Please note that this does NOT refer to the response message, but to the initial message i.e. pensioenaangiftebericht.
      operationId: GetMessageByUpaPensionDeclarationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 pension declaration.
          in: path
          name: upaPensionDeclarationId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/xml:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download the message of a of an UPA pension declaration
      tags:
        - Upa pension declaration
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/accumulatedbasicjournalresultsreport":
    get:
      description: |
        __Activity name :__ GetAccumulatedBasicJournalResultsReportByPayrollAdministrationId

        Acquire accumulated basic journal results reports (cumulatief journaal niet-verdicht en verdicht) at the payroll administration level. Currently this endpoint supports following report types to be requested:
        _Please note: this endpoint may only be used to acquire a report in the pdf-type format_ 
      operationId: GetAccumulatedBasicJournalResultsReportByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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/pdf
            type: string
        - description: The unique identifier of an administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
        - description: The type of report that is requested.
          example: nonAggregated
          in: query
          name: reportType
          required: true
          schema:
            enum:
              - nonAggregated
              - aggregatedPerGeneralLedgerAccount
            type: string
        - description: The type of grouping that is requested. This affects the way the data is presented within the given report.
          example: perPeriod
          in: query
          name: groupingType
          required: true
          schema:
            enum:
              - perPeriod
              - perDistributionUnit
              - perPeriodPerDistributionUnit
            type: string
        - description: First period (=from) of the requested timebox. Use the format 'YYYYPP'
          example: 201901
          in: query
          name: startPeriod
          required: true
          schema:
            minimum: 0
            type: integer
        - description: Last period (=up to and including) of the requested timebox. Use the following 'YYYYPP'
          example: 201912
          in: query
          name: endPeriod
          required: true
          schema:
            minimum: 0
            type: integer
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download accumulated basic journal results report
      tags:
        - Payroll administration reports
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/accumulationsandbalancesreport":
    get:
      description: |
        __Activity name :__ GetAccumulationsAndBalancesReportByPayrollAdministrationId

        Acquire the reports for either accumulations or balances at the payroll administration level. Currently this endpoint supports following report types to be requested:
        * baseForCalculationBalancesAtStartOfYear (grondslag begin jaar)

        * leaveBalancesAtStartOfYear (verlof begin jaar)

        * leaveAccrualWithinYear (opbouw verlof ulsa)
      operationId: GetAccumulationsAndBalancesReportByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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/pdf
            type: string
        - description: The unique identifier of an administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
        - description: The type of report that is requested.
          example: baseForCalculationBalancesAtStartOfYear
          in: query
          name: reportType
          required: true
          schema:
            enum:
              - baseForCalculationBalancesAtStartOfYear
              - leaveBalancesAtStartOfYear
              - leaveAccrualWithinYear
            type: string
        - description: A valid year for which the information is requested.
          example: "2023"
          in: query
          name: reportYear
          required: true
          schema:
            type: integer
        - description: If set to true employments with an enddate before the start of the reportYear will be included in the output.
          example: false
          in: query
          name: includeEmploymentsThatEndedBeforeStartOfTheYear
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
            text/csv:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download accumulations and balances reports
      tags:
        - Payroll administration reports
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/annualpayrolltaxreturnreport":
    get:
      description: |
        __Activity name :__ GetAnnualPayrollTaxReturnReportByPayrollAdministrationId

        Acquire the annual payroll tax return report (jaaroverzicht loongaangiftestaat) on payroll administration level, as generated by the reporting service.

        _Please note: this endpoint may only be used to acquire a report in the pdf-type format_ 
      operationId: GetAnnualPayrollTaxReturnReportByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
        - description: A valid year for which the information is requested.
          example: "2023"
          in: query
          name: reportYear
          required: true
          schema:
            type: integer
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download annual payroll tax return report
      tags:
        - Payroll administration reports
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/annualwagesheetreport":
    get:
      description: |
        __Activity name :__ GetAnnualWagesheetReportByPayrollAdministrationId

        Acquire the annual wage sheet report (verzamelloonstaat) on payroll administration level, as generated by the reporting service.

        __Note: __ For the querystring parameters take note of the following logic either reportYear has a value or start and endperiod have a value
      operationId: GetAnnualWagesheetReportByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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/pdf
            type: string
        - description: The unique identifier of an administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
        - description: A valid year for which the information is requested.
          example: "2023"
          in: query
          name: reportYear
          required: false
          schema:
            type: integer
        - description: First period (=from) of the requested timebox. Use the format 'YYYYPP'
          example: 201901
          in: query
          name: startPeriod
          required: false
          schema:
            minimum: 0
            type: integer
        - description: Last period (=up to and including) of the requested timebox. Use the following 'YYYYPP'
          example: 201912
          in: query
          name: endPeriod
          required: false
          schema:
            minimum: 0
            type: integer
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
            text/csv:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download annual wage sheet report
      tags:
        - Payroll administration reports
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/apgpensiondeclarations":
    get:
      description: |
        __Activity name :__ GetApgPensionDeclarationsByPayrollAdministrationId


        A list of APG pension declarations for an administration
      operationId: GetApgPensionDeclarationsByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 administration
          in: path
          name: payrollAdministrationId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            apgPensionDeclarationStatus:
                              description: |
                                The current status of the tax return
                                Possible values:
                                * Verzoek tot aanmaak pensioenaangifte (key = 1)
                                * Fout bij aanmaken pensioenaangifte (key = 2)
                                * Pensioenaangifte aangemaakt (key = 3)
                                * Pensioenaangifte geannuleerd (key = 4)
                                * Pensioenaangifte bevestigd (key = 5)
                                * Pensioenaangifte verzonden (key = 6)
                                * Pensioenaangifte verwijderd (key = 7)
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 3
                                  format: int32
                                  type: integer
                                value:
                                  example: Pensioenaangifte aangemaakt
                                  type: string
                              readOnly: true
                              type: object
                            approvalTime:
                              description: The time at which the payroll run was approved by the user
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            approvedBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            cancelledBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            cancelledTime:
                              description: The time at which the payroll run was Cancelled by the user
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            creationTime:
                              description: The time at which the pension message was requested by the user
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            customerGroupNumber:
                              description: Pension declarations will alway be grouped by its customerGroupNumber (klantgroepnummer).
                              format: int32
                              nullable: false
                              readOnly: true
                              type: integer
                            externalParty:
                              description: External party (externe partij)
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 13
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: PFZW (APG)
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              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
                            messageReference:
                              description: |
                                The message reference (berichtkenmerk) to recognize the given declaration.
                              example: "190"
                              nullable: true
                              readOnly: true
                              type: string
                            methodOfCreation:
                              description: Method by which the creation of the run was triggered.
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Individueel
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            period:
                              format: metadata
                              properties:
                                periodEndDate:
                                  description: The end date of the period
                                  example: 2021-11-30
                                  format: date
                                  nullable: false
                                  readOnly: false
                                  type: string
                                periodId:
                                  description: The periodId of the payroll period.
                                  example: 202101
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                periodNumber:
                                  description: The period number of the payroll period for which the pension declaration was created. In case of a yearly tax return this value will be set to 0
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                periodStartDate:
                                  description: The start date of the period
                                  example: 2021-11-01
                                  format: date
                                  nullable: false
                                  readOnly: false
                                  type: string
                                periodType:
                                  description: Indicates the frequence of the process. Payrolling can be done on a montly, 4-weekly or weekly basis.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    value:
                                      example: month
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                year:
                                  description: The year of the period for which the pension declaration was created.
                                  example: 2017
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              type: object
                            removeTime:
                              description: The time at which the pay roll run was removed.
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            removedBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            requestTime:
                              description: The time at which the  run was requested by the user
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            requestedBy:
                              format: metadata
                              nullable: false
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            responseMessages:
                              items:
                                properties:
                                  datetimeOfMessageReceipt:
                                    description: The date on which the original message was received by the external entity
                                    example: 2016-01-19
                                    format: date-time
                                    nullable: true
                                    readOnly: true
                                    type: string
                                  datetimeOfRegistration:
                                    description: The date on which the response message was registered in Loket
                                    example: 2016-01-19
                                    format: date-time
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  description:
                                    description: The description of the response message
                                    example: Bestand ontvangen
                                    nullable: true
                                    readOnly: true
                                    type: string
                                type: object
                              type: array
                            sentTime:
                              description: The time at which the pay roll run was sent.
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            withholdingAgentName:
                              description: |
                                The withholding agent name (naam inhoudingsplichtige) for this return.
                              example: Ben-Hur BV Via Roma
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 APG pension declarations for an administration
      tags:
        - Apg pension declaration
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/apgpensiondeclarations/initiate":
    post:
      description: |
        __Activity name :__ PostInitiateApgPensionDeclarationByPayrollAdministrationId


        Initiate the pension declaration for the next available period for the payrolladministration. Information about the next available periode can be obtained using the defaults endpoint (/defaults) 
      operationId: PostInitiateApgPensionDeclarationByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "202":
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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)
                            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: Accepted
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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 a APG pension declaration
      tags:
        - Apg pension declaration
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/attachmentsofearningsreport":
    get:
      description: |
        __Activity name :__ GetAttachmentsOfEarningsReportByPayrollAdministrationId

        Download the attachment of earnings report for the administration
      operationId: GetAttachmentsOfEarningsReportByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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/pdf
            type: string
        - description: The unique identifier of an administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
        - description: A valid year for which the information is requested.
          example: "2023"
          in: query
          name: reportYear
          required: true
          schema:
            type: integer
      responses:
        "200":
          content:
            text/csv:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download attachment of earnings report
      tags:
        - Payroll administration reports
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/auditTrail/PayrollPeriodData":
    get:
      description: |
        __Activity name :__ GetPayrollPeriodDataAuditTrailByPayrollAdministrationId

        Get the audit trail for the payroll period data. 
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
        - description: The start date
          in: query
          name: startDate
          required: true
          schema:
            example: 2020-08-01
            pattern: date
            type: string
        - description: The end date
          in: query
          name: endDate
          required: true
          schema:
            example: 2020-08-31
            pattern: 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:
                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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            employee:
                              properties:
                                employeeNumber:
                                  description: The employee number to uniquely identify a employee within an employer.
                                  example: 156
                                  format: int32
                                  nullable: true
                                  readOnly: true
                                  type: integer
                                id:
                                  description: The unique identifier (GUID/UUID)
                                  example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                  format: uuid
                                  nullable: true
                                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                  readOnly: true
                                  type: string
                                name:
                                  description: The name of the employee
                                  example: Bergen
                                  maxLength: 25
                                  nullable: true
                                  readOnly: true
                                  type: string
                              type: object
                            employer:
                              properties:
                                companyName:
                                  description: Name of the company
                                  example: Voorbeeld B.V.
                                  maxLength: 70
                                  nullable: false
                                  readOnly: false
                                  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 (GUID/UUID)
                                  example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                  format: uuid
                                  nullable: true
                                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                  readOnly: true
                                  type: string
                              type: object
                            employment:
                              properties:
                                id:
                                  description: The unique identifier (GUID/UUID)
                                  example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                  format: uuid
                                  nullable: true
                                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                  readOnly: true
                                  type: string
                                startDate:
                                  description: The date on which this employment starts.
                                  example: 2018-01-01
                                  format: date
                                  nullable: true
                                  readOnly: true
                                  type: string
                              type: object
                            field:
                              description: |
                                The application that performed the mutation
                              format: metadata
                              properties:
                                key:
                                  description: The key of the field
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  description: Description of the field
                                  example: Achternaam
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            identification:
                              description: |
                                The identification of the entity record that was changed
                              nullable: true
                              properties:
                                costCenter:
                                  description: |
                                    The cost center on which the payroll period data for this record will be booked for the ledger.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    code:
                                      example: SAL073
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    description:
                                      example: Sales Den Bosch
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                costUnit:
                                  description: |
                                    The cost unit on which the data for this record will be booked for the ledger
                                  format: metadata
                                  nullable: true
                                  properties:
                                    code:
                                      example: "01"
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    description:
                                      example: Cars
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                description:
                                  description: Extra identifying information for the mutation
                                  example: Datum ingang 03-03-2005
                                  maxLength: 255
                                  nullable: true
                                  readOnly: true
                                  type: string
                                distributionUnit:
                                  description: |
                                    Distribution unit, used in several reports and the "basic wage journal" functionality. Commonly used as a cost center.
                                  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:
                                      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
                                  type: object
                                id:
                                  description: The ID of the entity record that was changed
                                  example: 904d6856-6034-4624-bcbc-886188c115c5
                                  format: uuid
                                  nullable: true
                                  type: string
                                payrollPeriod:
                                  format: metadata
                                  nullable: true
                                  properties:
                                    periodEndDate:
                                      description: |
                                        The last day of the period to which the payroll period data applies
                                      example: 2018-01-31
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    periodNumber:
                                      description: |
                                        The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period in which the payroll data is to be processed.
                                      example: 1
                                      format: int32
                                      maximum: 53
                                      minimum: 1
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    periodStartDate:
                                      description: |
                                        The first day of the period to which the payroll period data applies
                                      example: 2018-01-01
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    year:
                                      description: |
                                        The year of the payroll period in which the payroll data is to be processed
                                      example: 2017
                                      format: int32
                                      maximum: 9999
                                      minimum: 2000
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                  readOnly: true
                                  type: object
                                payslipType:
                                  description: |
                                    The type of payslip (as defined by the Dutch tax authorities)
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    value:
                                      example: Bijzonder tarief strook
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                shift:
                                  description: |
                                    The shift determines the full-time hours and bonus percentage.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    bonusPercentage:
                                      description: |
                                        The bonus percentage used in wage calculations for the hours made in this shift.
                                      example: 12
                                      nullable: false
                                      readOnly: true
                                      type: number
                                    fullTimeHoursPerWeek:
                                      description: |
                                        The full time hours for an employment that is linked to this shift.
                                      example: 40
                                      nullable: false
                                      readOnly: true
                                      type: number
                                    shiftNumber:
                                      description: |
                                        The number for the shift. Loket.nl supports a maximum of 5 shifts per payroll administration.
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                              type: object
                            mutationOrigin:
                              description: |
                                The origin of the mutation
                                For example:
                                * By user * Automatich process * Collective change * Import
                              format: metadata
                              properties:
                                key:
                                  description: The key of the mutationOrigin
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: Description of the mutationOrigin
                                  example: Import
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            mutationType:
                              description: |
                                The type of mutation


                                  * create (toevoegen)
                                  * update (wijzigen)
                                  * delete (verwijderen)
                              format: metadata
                              properties:
                                key:
                                  description: The key of the mutationType
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: Description of the mutationType
                                  example: toevoegen
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            newValue:
                              description: |-
                                The value of the field after the change. 
                                Incase of an delete the nieuwValue will be NULL.
                              example: Hermans
                              maxLength: 250
                              nullable: true
                              readOnly: true
                              type: string
                            oldValue:
                              description: |-
                                The value befor the change. 
                                Incase of an create the oldValue will be NULL.
                              example: Hermanss
                              maxLength: 250
                              nullable: true
                              readOnly: true
                              type: string
                            payrollAdministration:
                              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
                                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 administration
                                  example: ABC accountants
                                  maxLength: 70
                                  nullable: false
                                  readOnly: false
                                  type: string
                              type: object
                            payrollComponentCategory:
                              description: |
                                If the field is a payroll component this field will indicate the category of the payroll component otherwise its null. Example categories are, hours/extra hours/net payment/net deduction etc.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: Uren
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            performedBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            timeStamp:
                              description: The time the mutation was performed
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payroll period data audit trail
      tags:
        - Audit trail
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/availablepayrollcomponentsets":
    get:
      description: |
        __Activity name :__ GetAvailablePayrollComponentSetsByPayrollAdministrationId
        Get the available payroll components sets that are available at this level.  A payroll component set defines a set of payroll components to be used as a sjabloon preventing the need for users to constatnly select the same set of payroll components. Payroll component set are commonly used when entering payroll period data (variabele gegevens) either for a single employment or for multiple employments (browser variabele gegevens). They are also used as a filter when exporting payroll run results.

        Both at the provider level and payroll administration the user may define sets and which components it includes. This endpoint will return an aggregated view of the applicable sets and its corresponding component based on the defined sets at provider and administration level.
      operationId: GetAvailablePayrollComponentSetsByPayrollAdministrationId
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          description: The aggregated payroll component sets
                          nullable: false
                          properties:
                            description:
                              example: Standaard exportset
                              maxLength: 50
                              nullable: false
                              readOnly: true
                              type: string
                            id:
                              description: |
                                The unique identifier of the payroll component set that is to be used as default set when editing payroll periode data for all employments of a payroll administration
                              example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                              format: uuid
                              nullable: true
                              pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                              readOnly: true
                              type: string
                            isDefaultForBrowserPayrollPeriodData:
                              description: |
                                The default set is defined on payroll administration level.  To be used for the "browser variabele gegevens" to indication which set of component should be displayed by default.
                              example: false
                              nullable: false
                              readOnly: true
                              type: boolean
                            isDefaultForPayrollPeriodData:
                              description: |
                                The default set is defined on payroll administration level.  To be used for the "variabele gegevens" for an employment to indication which set of component should be displayed by default.
                              example: true
                              nullable: false
                              readOnly: true
                              type: boolean
                            isDefinedOnProviderLevel:
                              description: |
                                The set is defined at either the provider or at the payroll administration level. If this indication is true then the set was defined at provider, if false than it is defined at payroll administration level.
                              example: true
                              nullable: false
                              readOnly: true
                              type: boolean
                            payrollComponents:
                              items:
                                properties:
                                  payrollComponent:
                                    description: |
                                      A payroll component. These components are the core of the wage calculation software.

                                      `payrollComponents` is a metadata field within the payroll administration, loonmodel and cao context. Possible values can be managed by the user.
                                    format: metadata
                                    properties:
                                      canBeSupplemented:
                                        description: |
                                          Indicates whether the atribute for this payroll component can have the value `supplement`. Refer to the description of the attribute field for an explanation.
                                        example: false
                                        nullable: false
                                        readOnly: true
                                        type: boolean
                                      category:
                                        description: |
                                          The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.
                                        format: metadata
                                        nullable: false
                                        properties:
                                          key:
                                            example: 1
                                            format: int32
                                            nullable: false
                                            readOnly: true
                                            type: integer
                                          value:
                                            example: Uren
                                            nullable: false
                                            readOnly: true
                                            type: string
                                        readOnly: true
                                        type: object
                                      deductionOrPayment:
                                        description: |
                                          Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
                                        format: metadata
                                        nullable: true
                                        properties:
                                          key:
                                            example: 2
                                            format: int32
                                            nullable: false
                                            readOnly: true
                                            type: integer
                                          value:
                                            example: Betaling
                                            nullable: false
                                            readOnly: true
                                            type: string
                                        readOnly: true
                                        type: object
                                      key:
                                        description: |
                                          The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart.
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        description: |
                                          The description of the payroll component
                                        example: Uren gewerkt
                                        maxLength: 14
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                type: object
                              type: array
                          readOnly: true
                          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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Available payroll component sets
      tags:
        - Payroll component set
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/deviatingpremiumswab":
    get:
      description: |
        __Activity name :__ GetDeviatingPremiumsWabReportByPayrollAdministrationId

        The percentage deviation between the contract hours and the actual standard hours to assess whether the low wab premium should be revised to the high wab premium.
      operationId: GetDeviatingPremiumsWabReportByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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/pdf
            type: string
        - description: The unique identifier of an administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
        - description: A valid year for which the information is requested.
          example: "2023"
          in: query
          name: reportYear
          required: true
          schema:
            type: integer
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download WAB deviations report
      tags:
        - Payroll administration reports
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/employmentPayrollDataAuditTrail":
    get:
      description: |-
        __Activity name :__ GetEmploymentPayrollDataAuditTrailByPayrollAdministrationId

        Returns the changes that were made in the payroll data for the employments. 

        This includes resources such as (allmost all payroll related resources except `payroll period data` which has its own audit trail download):
        - Wage
        - Working hours
        - Bennefits and deductions
        - Employment
        - Fiscal properties
        - Organizational entity
      operationId: GetEmploymentPayrollDataAuditTrailByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
        - description: The start date
          in: query
          name: startDate
          required: true
          schema:
            example: 2020-08-01
            pattern: date
            type: string
        - description: The end date
          in: query
          name: endDate
          required: true
          schema:
            example: 2020-08-31
            pattern: date
            type: string
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download the audit trail for the employment payroll data
      tags:
        - Audit trail payroll run
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns":
    get:
      description: |
        __Activity name :__ GetJournalRunsByPayrollAdministrationId

        Returns the journal runs for a payroll administration.
      operationId: GetJournalRunsByPayrollAdministrationId
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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
                            journalRunStatus:
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: |
                                    Possible values for the payroll run status are;

                                    * 0	Staat klaar voor journaliseren
                                    * 1	Geen journaal resultaten
                                    * 2	Fout bij aanmaken
                                    * 3	Verwijderd door gebruiker
                                    * 4	Journaal gereed
                                    * 5	Wordt geëxporteerd
                                    * 6	Exporteren mislukt
                                    * 7	Journaal geëxporteerd
                                  example: 4
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: The value describing the current status of the payroll run.
                                  example: Journaal gereed
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            methodOfCreation:
                              description: Method by which the creation of the journal run was triggered.
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Individueel
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            payrollRun:
                              properties:
                                payrollPeriod:
                                  format: metadata
                                  properties:
                                    periodEndDate:
                                      description: The last day of the period for which the tax return message was created
                                      example: 2018-01-31
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    periodNumber:
                                      description: The period number of the payroll period the record relates to
                                      example: 1
                                      format: int32
                                      nullable: true
                                      readOnly: false
                                      type: integer
                                    periodStartDate:
                                      description: The first day of the period for which the tax return message was created
                                      example: 2018-01-01
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    testYear:
                                      description: |-
                                        Indicates whether the payroll periode is part of a test year.

                                        In Loket it is possible to run a year of a payrolladministration as a so-called test year.  This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. 
                                        Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
                                      example: false
                                      nullable: false
                                      readOnly: true
                                      type: boolean
                                    year:
                                      description: The year of the payroll period the record relates to
                                      example: 2017
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                  type: object
                                payrollRunId:
                                  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
                                sequenceNumberApproved:
                                  description: "Ascending sequence number related to an approved payrol run. A payroll run may have more than one journal run. With this number the journal run may be linked to the specific payroll run. "
                                  example: 6
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              type: object
                            processingFinishedTime:
                              description: The time at which at which the journal run was finished processing
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            removeTime:
                              description: The time at which the journal run was removed.
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            removedBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            requestTime:
                              description: The time at which the payroll run was requested by the user
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            requestedBy:
                              format: metadata
                              nullable: false
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            sequenceNumber:
                              description: Ascending sequence number over ALL journal runs for the payroll administration.
                              example: 8
                              format: int32
                              nullable: false
                              readOnly: true
                              type: integer
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 journal runs for an administration
      tags:
        - Journal run
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns/initiate":
    post:
      description: |-
        __Activity name :__ PostInitiateJournalRunByPayrollAdministrationId This is a controller endpoint to perform an action.

        In the older Loket GUI this specific action is referred to as 'journaliseren' If this action is performed succesfully the journal run will be created with status 0 and will be queud for processing. After the initiated run has been picked up and processed by the background process, then the status of the run will be changed accordingly.

        This action may be performed for all payroll periods that are *available for the payroll administration* AND that meet one of the following requirements;
        * The payroll period is less then 7 years in the past
        * There is a journal profile configured for the given payroll period
        * There is an approved payroll run for the given payroll period that has no other journalruns except for failed or removed journalruns
        * All the payroll runs are processed in order so in order to start a journalrun the previous payrollrun (that should have a journalrun) has to have a succesfull journal run in order to start the next one

        __Metadata :__  No metadata endpoint available for this controller endpoint.

        __Defaults :__ Defaults endpoint is available for this controller endpoint by adding /defaults. Also, an endpoint is available to retrieve initiation values for a specific period.
      operationId: PostInitiateJournalRunByPayrollAdministrationId
      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 <TOKEN>
            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:
        "202":
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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)
                            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
                          journalRunStatus:
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  Possible values for the payroll run status are;

                                  * 0	Staat klaar voor journaliseren
                                  * 1	Geen journaal resultaten
                                  * 2	Fout bij aanmaken
                                  * 3	Verwijderd door gebruiker
                                  * 4	Journaal gereed
                                  * 5	Wordt geëxporteerd
                                  * 6	Exporteren mislukt
                                  * 7	Journaal geëxporteerd
                                example: 4
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: The value describing the current status of the payroll run.
                                example: Journaal gereed
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          methodOfCreation:
                            description: Method by which the creation of the journal run was triggered.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Individueel
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          payrollRun:
                            properties:
                              payrollPeriod:
                                format: metadata
                                properties:
                                  periodEndDate:
                                    description: The last day of the period for which the tax return message was created
                                    example: 2018-01-31
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  periodNumber:
                                    description: The period number of the payroll period the record relates to
                                    example: 1
                                    format: int32
                                    nullable: true
                                    readOnly: false
                                    type: integer
                                  periodStartDate:
                                    description: The first day of the period for which the tax return message was created
                                    example: 2018-01-01
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  testYear:
                                    description: |-
                                      Indicates whether the payroll periode is part of a test year.

                                      In Loket it is possible to run a year of a payrolladministration as a so-called test year.  This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. 
                                      Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
                                    example: false
                                    nullable: false
                                    readOnly: true
                                    type: boolean
                                  year:
                                    description: The year of the payroll period the record relates to
                                    example: 2017
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                type: object
                              payrollRunId:
                                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
                              sequenceNumberApproved:
                                description: "Ascending sequence number related to an approved payrol run. A payroll run may have more than one journal run. With this number the journal run may be linked to the specific payroll run. "
                                example: 6
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                            type: object
                          processingFinishedTime:
                            description: The time at which at which the journal run was finished processing
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          removeTime:
                            description: The time at which the journal run was removed.
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          removedBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          requestTime:
                            description: The time at which the payroll run was requested by the user
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          requestedBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          sequenceNumber:
                            description: Ascending sequence number over ALL journal runs for the payroll administration.
                            example: 8
                            format: int32
                            nullable: false
                            readOnly: true
                            type: integer
                        type: object
                    type: object
          description: Accepted
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Initiate journal run (journaliseren)
      tags:
        - Journal run
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriodDataAuditTrail":
    get:
      description: |-
        __Activity name :__ GetPayrollPeriodDataAuditTrailByPayrollAdministrationId

        Returns the changes that were made in the payroll period data from the given start up to and including the given end date.
      operationId: GetPayrollPeriodDataAuditTrailByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
        - description: The start date
          in: query
          name: startDate
          required: true
          schema:
            example: 2020-08-01
            pattern: date
            type: string
        - description: The end date
          in: query
          name: endDate
          required: true
          schema:
            example: 2020-08-31
            pattern: date
            type: string
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download the audit trail for the payroll period data
      tags:
        - Audit trail
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/{payrollPeriodId}/payrollperioddata":
    get:
      description: |
        __Activity name :__ GetPayrollPeriodDataByPayrollAdministrationIdAndPayrollPeriodId

        Get a list of all payroll period data for all the active employment in the given payroll period for the give payroll administration. Payroll period data relates to a single payroll period.

        This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.

        __Metadata :__  Possible options for the query string parameters can be acquired (GET) via the `/metadata` endpoint.  The URI for this endpoint is `../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/payrollperioddata/metadata`.

        __Defaults :__ Default values for the query string parameters can be acquired via the `/defaults` endpoint.  The URI for this endpoint is `../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/payrollperioddata/defaults`.
      operationId: GetPayrollPeriodDataByPayrollAdministrationIdAndPayrollPeriodId
      parameters:
        - description: The unique identifier of an administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of the payroll period
          in: path
          name: payrollPeriodId
          required: true
          schema:
            format: int32
            type: integer
        - description: Controles which payroll period data is returned either for the normal payslip of the tarif payslip.
          in: query
          name: payslipType
          required: true
          schema:
            format: int32
            type: integer
        - description: |-
            A predefined set of payroll components to filter which payroll components are returned.

            __Note:__ Either `payrollComponentSet` or `payrollComponentCategory` must have a value.

            Mutually exclusive with `payrollComponentCategory`.
          in: query
          name: payrollComponentSet
          required: false
          schema:
            format: uuid
            type: string
        - description: |-
            A predefined category of payroll components to filter which payroll components are returned.

            __Note:__ Either `payrollComponentSet` or `payrollComponentCategory` must have a value.

            Mutually exclusive with `payrollComponentSet`.
          in: query
          name: payrollComponentCategory
          required: false
          schema:
            format: int32
            type: integer
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            costCenter:
                              description: |
                                The cost center on which the payroll period data for this record will be booked for the ledger.
                              format: metadata
                              nullable: true
                              properties:
                                code:
                                  example: SAL073
                                  nullable: false
                                  readOnly: true
                                  type: string
                                description:
                                  example: Sales Den Bosch
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            costUnit:
                              description: |
                                The cost unit on which the data for this record will be booked for the ledger
                              format: metadata
                              nullable: true
                              properties:
                                code:
                                  example: "01"
                                  nullable: false
                                  readOnly: true
                                  type: string
                                description:
                                  example: Cars
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            distributionUnit:
                              description: |
                                Distribution unit, used in several reports and the "basic wage journal" functionality. Commonly used as a cost center.
                              format: metadata
                              nullable: false
                              properties:
                                code:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                description:
                                  example: Sales
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  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
                              type: object
                            employee:
                              properties:
                                employeeNumber:
                                  description: |
                                    The employee number to uniquely identify an employee within an employer
                                  example: 156
                                  format: int32
                                  minimum: 1
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            employment:
                              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
                                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: false
                                  readOnly: true
                                  type: integer
                                payrollId:
                                  description: The payrolling number for this employment of the employee. Used by the payroll engine. This number is automatically generated and cannot be changed by the user.
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              type: object
                            payrollComponents:
                              items:
                                properties:
                                  isSupplement:
                                    description: |
                                      This boolean determines what the salary calculation will do with the value of the payroll component if the payroll component has values in both the payroll period specific data (this endpoint) and in the non-payroll period specific configuration of the employment (it is possible to configure values for payroll components that span multiple payroll periods and even parts thereof).

                                      * When set to `false`, the value of the payroll component will overwrite the value specified in the non-payroll period specific data with the given value in the payroll period specific date.

                                      * When set to `true`, the value of the payroll period specific data will be added to the value of the non-payroll period specific data. Note that a value can be a negative number. For instance, a payroll period specific value of 20 and a non-payroll period specific value of -8 will effectively result in 12 for salary calculation.

                                      This boolean can only be set to `true` in components for which `payrollComponent.canBesupplemented = true`.
                                    example: false
                                    nullable: true
                                    readOnly: false
                                    type: boolean
                                  payrollComponent:
                                    description: |
                                      A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment for the given payroll period.  <br/>  Please note: Business rules may differ per component! Understanding these business rules and corresponding validations requires functional knowledge of Loket.
                                    format: metadata
                                    properties:
                                      canBeSupplemented:
                                        description: |
                                          Indicates whether the atribute for this payroll component can have the value `supplement`. Refer to the description of the attribute field for an explanation.
                                        example: false
                                        nullable: false
                                        readOnly: true
                                        type: boolean
                                      category:
                                        description: |
                                          The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.
                                        format: metadata
                                        nullable: false
                                        properties:
                                          key:
                                            example: 1
                                            format: int32
                                            nullable: false
                                            readOnly: true
                                            type: integer
                                          value:
                                            example: Uren
                                            nullable: false
                                            readOnly: true
                                            type: string
                                        readOnly: true
                                        type: object
                                      deductionOrPayment:
                                        description: |
                                          Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
                                        format: metadata
                                        nullable: true
                                        properties:
                                          key:
                                            example: 2
                                            format: int32
                                            nullable: false
                                            readOnly: true
                                            type: integer
                                          value:
                                            example: Betaling
                                            nullable: false
                                            readOnly: true
                                            type: string
                                        readOnly: true
                                        type: object
                                      description:
                                        description: |
                                          The description of the payroll component
                                        example: Uren gewerkt
                                        maxLength: 14
                                        nullable: false
                                        readOnly: true
                                        type: string
                                      key:
                                        description: |
                                          The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know it by heart.
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                    type: object
                                  value:
                                    description: |
                                      Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules).
                                    example: 144
                                    nullable: true
                                    readOnly: false
                                    type: number
                                type: object
                              minimum: 0
                              type: array
                            payrollPeriod:
                              format: metadata
                              nullable: false
                              properties:
                                periodEndDate:
                                  description: |
                                    The last day of the period to which the payroll period data applies
                                  example: 2018-01-31
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                periodNumber:
                                  description: |
                                    The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period in which the payroll data is to be processed.
                                  example: 1
                                  format: int32
                                  maximum: 53
                                  minimum: 1
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                periodStartDate:
                                  description: |
                                    The first day of the period to which the payroll period data applies
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                year:
                                  description: |
                                    The year of the payroll period in which the payroll data is to be processed
                                  example: 2017
                                  format: int32
                                  maximum: 9999
                                  minimum: 2000
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              readOnly: true
                              type: object
                            payslipType:
                              description: |
                                The type of payslip (as defined by the Dutch tax authorities)
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: Bijzonder tarief strook
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            shift:
                              description: |
                                The shift determines the full-time hours and bonus percentage.
                              format: metadata
                              nullable: false
                              properties:
                                bonusPercentage:
                                  description: |
                                    The bonus percentage used in wage calculations for the hours made in this shift.
                                  example: 12
                                  nullable: false
                                  readOnly: true
                                  type: number
                                fullTimeHoursPerWeek:
                                  description: |
                                    The full time hours for an employment that is linked to this shift.
                                  example: 40
                                  nullable: false
                                  readOnly: true
                                  type: number
                                shiftNumber:
                                  description: |
                                    The number for the shift. Loket.nl supports a maximum of 5 shifts per payroll administration.
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payroll period data on payroll administration level
      tags:
        - Payroll period data on administration level
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/payrolladministrationsettingsreport":
    get:
      description: |
        __Activity name :__ GetPayrollAdministrationSettingsReportByPayrollAdministrationId

        Acquire the payroll administration configuration report (overzicht inrichting salarisverwerking) on payroll administration level for a year, as generated by the reporting service.

        _Please note: this endpoint may only be used to acquire a report in the pdf-type format_ 
      operationId: GetPayrollAdministrationSettingsReportByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
        - description: A valid year for which the information is requested.
          example: "2023"
          in: query
          name: reportYear
          required: true
          schema:
            type: integer
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download payroll administration configuration report
      tags:
        - Payroll administration reports
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollcomponents/year/{year}":
    get:
      description: |
        __Activity name :__ GetPayrollComponentsByPayrollAdministrationIdAndYear
        Get the available payroll components for an administration. 
      operationId: GetPayrollComponentsByPayrollAdministrationIdAndYear
      parameters:
        - description: The unique identifier of an administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
        - description: The payroll year
          in: path
          name: year
          required: true
          schema:
            example: 2018
            format: int32
            maxLength: 4
            type: integer
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            canBeSupplemented:
                              description: |
                                Indicates whether the atribute for this payroll component can have the value `supplement`. Refer to the description of the attribute field for an explanation.
                              example: false
                              nullable: false
                              readOnly: true
                              type: boolean
                            category:
                              description: |
                                The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: Uren
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            deductionOrPayment:
                              description: |
                                Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: Betaling
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            definedAtLevel:
                              description: |
                                The component is defined at either cao, loonmodel or payroll administration level. If this indication is true then the set was defined at provider, if false than it is defined at payroll administration level.
                              enum:
                                - employer
                                - provider
                                - loket
                              example: employer
                              nullable: false
                              readOnly: true
                              type: string
                            description:
                              description: |
                                The description of the payroll component
                              example: Uren gewerkt
                              maxLength: 14
                              nullable: false
                              readOnly: true
                              type: string
                            key:
                              description: |
                                The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart.
                              example: 1
                              format: int32
                              nullable: false
                              readOnly: false
                              type: integer
                        type: array
                    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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Payroll components
      tags:
        - Payroll components
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods":
    get:
      description: |
        __Activity name :__ GetPayrollPeriodsByPayrollAdministrationId

        Returns a list of all payroll periods available for the given payroll administration 
      operationId: GetPayrollPeriodsByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 administration
          in: path
          name: payrollAdministrationId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            automaticProcessing:
                              nullable: true
                              properties:
                                approvePayrollRunOn:
                                  description: The date on which the payroll run for this period is automatically approved (if all prerequisite are met).
                                  example: 2020-01-23
                                  format: date
                                  nullable: true
                                  readOnly: true
                                  type: string
                                createPayrollRunOn:
                                  description: The date on which the payroll run for this period is automatically created (if all prerequisite are met).
                                  example: 2020-01-18
                                  format: date
                                  nullable: true
                                  readOnly: true
                                  type: string
                                hasAutomaticPayrollRunApprovalBeenExecuted:
                                  type: boolean
                                hasAutomaticPayrollRunCreationBeenExecuted:
                                  type: boolean
                              readOnly: true
                              type: object
                            endDate:
                              description: The last day of the payroll period
                              example: 2020-01-31
                              format: date
                              nullable: false
                              readOnly: true
                              type: string
                            id:
                              description: The id for this specific payroll period.
                              example: 202001
                              format: int32
                              nullable: false
                              readOnly: true
                              type: integer
                            payrollPeriodType:
                              description: Indicates the frequence of the payrolling process. Payrolling can be done on a montly, 4-weekly or weekly basis.
                              nullable: false
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: month
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            payrollRuns:
                              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
                                  journalRuns:
                                    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
                                        journalRunStatus:
                                          format: metadata
                                          nullable: false
                                          properties:
                                            key:
                                              description: The key indicating the current status of the journal run.
                                              example: 4
                                              format: int32
                                              nullable: false
                                              readOnly: false
                                              type: integer
                                            value:
                                              description: The value describing the current status of the payroll run.
                                              example: Journaal gereed
                                              nullable: false
                                              readOnly: true
                                              type: string
                                          type: object
                                        sequenceNumber:
                                          description: Ascending sequence number over ALL journal runs for the payroll administration.
                                          example: 8
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                      type: object
                                    minItems: 0
                                    nullable: false
                                    type: array
                                  payrollRunStatus:
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        description: The key indicating the current status of the payroll run.
                                        example: 9
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        description: The value describing the current status of the payroll run.
                                        example: Verloning goedgekeurd.
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                  sequenceNumber:
                                    description: An incremental number with a payrolling year to uniquely identify a payroll run. Null can be returned for those runs that dont contain "wages".
                                    example: 1
                                    format: int32
                                    nullable: true
                                    readOnly: true
                                    type: integer
                                  sequenceNumberApproved:
                                    description: An incremental number with a payrolling year to uniquely identify an approved payroll run.
                                    example: 3
                                    format: int32
                                    nullable: true
                                    readOnly: true
                                    type: integer
                                type: object
                              minItems: 0
                              nullable: false
                              type: array
                            periodNumber:
                              description: The period number of the payroll period
                              example: 1
                              format: int32
                              nullable: false
                              readOnly: true
                              type: integer
                            startDate:
                              description: The first day of the payroll period
                              example: 2020-01-01
                              format: date
                              nullable: false
                              readOnly: true
                              type: string
                            testYear:
                              description: |-
                                Indicates whether the payroll year is a test year.

                                In Loket it is possible to run a year of a payrolladministration as a so-called test year.  This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. 
                                Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
                              example: false
                              nullable: false
                              readOnly: true
                              type: boolean
                            year:
                              description: The payroll year
                              example: 2020
                              format: int32
                              nullable: false
                              readOnly: true
                              type: integer
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 all available payroll periods and runs
      tags:
        - Payroll periods
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/compare":
    get:
      description: |
        __Activity name :__ GetComparePayrollPeriodsByPayrollAdministrationId  

        Returns the results of given payroll period and the one before so a comparison can be made. Currently only the components 260, 495, 257 are returned 
      operationId: GetComparePayrollPeriodsByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of the payroll period
          example: 202001
          in: query
          name: payrollPeriodId
          required: true
          schema:
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            numberOfPayrolledEmployments:
                              description: The number of employments that where payrolled
                              example: 34
                              format: int32
                              minimum: 0
                              nullable: false
                              readOnly: true
                              type: integer
                            payrollComponentResults:
                              items:
                                properties:
                                  payrollComponent:
                                    description: |
                                      A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                                      `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                    format: metadata
                                    properties:
                                      category:
                                        description: |
                                          The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.    
                                        format: metadata
                                        nullable: false
                                        properties:
                                          key:
                                            example: 1
                                            format: int32
                                            nullable: false
                                            readOnly: true
                                            type: integer
                                          value:
                                            example: Uren
                                            nullable: false
                                            readOnly: true
                                            type: string
                                        readOnly: true
                                        type: object
                                      column:
                                        description: |
                                          The wage sheet column (kolom) of the payroll component. Kolommen are related to its specific lines on the payslip and/or wage sheet.  Also this does bear some similiarties to wage sheets columns (loonstaatkolommen) used by the Belastingdienst, however the division of columns as used by Loket is not identical to that.
                                        format: metadata
                                        nullable: false
                                        properties:
                                          key:
                                            example: 6
                                            format: int32
                                            nullable: false
                                            readOnly: true
                                            type: integer
                                          value:
                                            example: Sociaalplichtig loon
                                            nullable: false
                                            readOnly: true
                                            type: string
                                        readOnly: true
                                        type: object
                                      costsEmployer:
                                        description: |
                                          Indicates whether the components are costs for the employer (+) or negative costs (-, i.e. benefit) for the employer. The value could also be NULL meaning that the component is not related to actual expenses.
                                        format: metadata
                                        nullable: true
                                        properties:
                                          key:
                                            example: 1
                                            format: int32
                                            nullable: false
                                            readOnly: true
                                            type: integer
                                          value:
                                            example: +
                                            nullable: false
                                            readOnly: true
                                            type: string
                                        readOnly: true
                                        type: object
                                      key:
                                        description: |
                                          The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart.
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        description: |
                                          The description of the payroll component
                                        example: Uren gewerkt
                                        maxLength: 14
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                  value:
                                    description: Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this.
                                    example: 40
                                    nullable: false
                                    readOnly: true
                                    type: number
                                  valueSpecialTariff:
                                    description: Value/ amount (speciaal tarief voor belasting) for the payrollcomponent. Both a 'normal' and 'special tariff' type payslip may a value for this. Also, both valueNormal and valueSpecialTariff may have a value at the same time.
                                    example: 144
                                    nullable: false
                                    readOnly: true
                                    type: number
                                type: object
                              type: array
                            payrollPeriod:
                              format: metadata
                              properties:
                                periodEndDate:
                                  description: The last day of the period for which the tax return message was created
                                  example: 2018-01-31
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                periodNumber:
                                  description: The period number of the payroll period the record relates to
                                  example: 1
                                  format: int32
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                periodStartDate:
                                  description: The first day of the period for which the tax return message was created
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                testYear:
                                  description: |-
                                    Indicates whether the payroll periode is part of a test year.

                                    In Loket it is possible to run a year of a payrolladministration as a so-called test year.  This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. 
                                    Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
                                  example: false
                                  nullable: false
                                  readOnly: true
                                  type: boolean
                                year:
                                  description: The year of the payroll period the record relates to
                                  example: 2017
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the results of the given payroll period and the one before
      tags:
        - Payroll results
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/initialise":
    post:
      description: |-
        __Activity name :__ PostInitialisePayrollPeriodByPayrollAdministrationId This is a controller endpoint to perform an action.


        In the older Loket GUI this specific action is referred to as 'Automatische processen activeren'. If this action is performed for the chosen payroll period then certain calculations will be performed on the background. The execution depends on the input parameters and the payroll configuration in the given situation.


        This action may be performed for all payroll periods that are available for the payroll administration AND that meet one of the following requirements;
        * Payroll periods for which an approved payroll run (status = 9) is available
        * The very first payroll period in time that does not yet have an approved payroll run(i.e. last payroll period with approved run + 1). Within each year, if available.

        In practice, in many instances the second option will be most relevant. Please note that if the action is performed for a year that is not the current active year of payrolling, then the resulting changes may not be fully processed in regards to the full payroll process.


        __Metadata :__  No metadata endpoint available for this controller endpoint.

        __Defaults :__ Defaults endpoint is available for this controller endpoint.
      operationId: PostInitialisePayrollPeriodByPayrollAdministrationId
      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 <TOKEN>
            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: false
              properties:
                payrollPeriod:
                  format: metadata
                  nullable: false
                  properties:
                    periodNumber:
                      description: |
                        The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period.
                      example: 1
                      format: int32
                      maximum: 53
                      minimum: 1
                      nullable: false
                      readOnly: false
                      type: integer
                    year:
                      description: |
                        The year of the payroll period
                      example: 2017
                      format: int32
                      maximum: 9999
                      minimum: 2000
                      nullable: false
                      readOnly: false
                      type: integer
                  type: object
                setAnnualBaseForCalculationsBasedOnFunds:
                  description: Jaargrondslag fondsen bepalen. Sets baseForCalculationsBasedOnFunds-related component(s) in the payroll period data based on the configuration of the employment.
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                setBaseForCalculations:
                  description: Grondslagen activeren. Sets baseForCalculation-related component(s) in the payroll period data based on the configuration of the employment.
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                setHoursWorked:
                  description: Berekenen uren. Sets hours worked-related component(s) in the payroll period data based on the configuration of the employment.
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                setLeaveHours:
                  description: Verlofuren op basis van uren bepalen. Sets leave hours-related component(s) in the payroll period data based on the configuration of the employment.
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
              type: object
        description: Perform Calculation Payload.
        required: true
      responses:
        "201":
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Initialise Payroll Period (automatische processen)
      tags:
        - Initialise Payroll Period
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/minimized":
    get:
      description: |
        __Activity name :__ GetPayrollPeriodsMinimizedByPayrollAdministrationId

        Returns a list of all payroll periods available for the given payroll administration 
      operationId: GetPayrollPeriodsMinimizedByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 administration
          in: path
          name: payrollAdministrationId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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 of the payroll period
                              example: 2020-01-31
                              format: date
                              nullable: false
                              readOnly: true
                              type: string
                            hasApprovedPayrollRun:
                              description: Indicates if the payroll period has atleast 1 approved payrollrun
                              example: false
                              nullable: false
                              readOnly: true
                              type: boolean
                            id:
                              description: The id for this specific payroll period.
                              example: 202001
                              format: int32
                              nullable: false
                              readOnly: true
                              type: integer
                            payrollPeriodType:
                              description: Indicates the frequence of the payrolling process. Payrolling can be done on a montly, 4-weekly or weekly basis.
                              nullable: false
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: month
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            periodNumber:
                              description: The period number of the payroll period
                              example: 1
                              format: int32
                              nullable: false
                              readOnly: true
                              type: integer
                            startDate:
                              description: The first day of the payroll period
                              example: 2020-01-01
                              format: date
                              nullable: false
                              readOnly: true
                              type: string
                            testYear:
                              description: |-
                                Indicates whether the payroll year is a test year.

                                In Loket it is possible to run a year of a payrolladministration as a so-called test year.  This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. 
                                Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
                              example: false
                              nullable: false
                              readOnly: true
                              type: boolean
                            year:
                              description: The payroll year
                              example: 2020
                              format: int32
                              nullable: false
                              readOnly: true
                              type: integer
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 all available payroll periods
      tags:
        - Payroll periods
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/{payrollPeriodId}/payrollresults":
    get:
      description: |
        __Activity name :__ GetPayrollPeriodResultsByPayrollAdministrationIdAndPayrollPeriodId  
          

        Returns the payroll results for the payroll period.

        __Note :__ This endpoint is related to the `GetPayrollRunResultsByPayrollRunId` endpoint.
        Both endpoints return the same output just in a different way. This endpoint returns the current state of the payroll results for the given period where as `GetPayrollRunResultsByPayrollRunId` returns the payroll results for the given payroll run (a payroll run can contain payroll results for multiple payroll periods). It's posible for payroll results to be created after the end of the payroll period it zelf. For example, the payroll periode 01-2020 ends at 31-01-2020 (in case of a monthly payroll period) it is posible that the payroll run for period 07-2020 contains payroll results for the period 01-2020 due to a retroactivity change for that period. This change in the payroll run for payroll period 07-2020 would require the system to reaquire the results for period 01-2020 (as they changed).
      operationId: GetPayrollPeriodResultsByPayrollAdministrationIdAndPayrollPeriodId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of the payroll period
          in: path
          name: payrollPeriodId
          required: true
          schema:
            format: int32
            type: integer
        - description: Can be used to filter what payroll components are returned. Cannot be used in combination with payrollComponentSet.
          in: query
          name: payrollComponents
          required: false
          schema:
            example: 70,151,12
            items:
              format: int32
              type: integer
            type: array
        - description: A predifined set of payroll components to filter what payroll components are returned
          in: query
          name: payrollComponentSet
          required: false
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            employmentId:
                              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
                            payrollPeriods:
                              items:
                                properties:
                                  payrollPeriod:
                                    format: metadata
                                    properties:
                                      periodEndDate:
                                        description: The last day of the period for which the tax return message was created
                                        example: 2018-01-31
                                        format: date
                                        nullable: false
                                        readOnly: true
                                        type: string
                                      periodNumber:
                                        description: The period number of the payroll period the record relates to
                                        example: 1
                                        format: int32
                                        nullable: true
                                        readOnly: false
                                        type: integer
                                      periodStartDate:
                                        description: The first day of the period for which the tax return message was created
                                        example: 2018-01-01
                                        format: date
                                        nullable: false
                                        readOnly: true
                                        type: string
                                      testYear:
                                        description: |-
                                          Indicates whether the payroll periode is part of a test year.

                                          In Loket it is possible to run a year of a payrolladministration as a so-called test year.  This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. 
                                          Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
                                        example: false
                                        nullable: false
                                        readOnly: true
                                        type: boolean
                                      year:
                                        description: The year of the payroll period the record relates to
                                        example: 2017
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                    type: object
                                  payslipTypes:
                                    items:
                                      properties:
                                        payrollComponentResults:
                                          items:
                                            properties:
                                              payrollComponent:
                                                description: |
                                                  A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                                                  `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                                format: metadata
                                                properties:
                                                  category:
                                                    description: |
                                                      The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.    
                                                    format: metadata
                                                    nullable: false
                                                    properties:
                                                      key:
                                                        example: 1
                                                        format: int32
                                                        nullable: false
                                                        readOnly: true
                                                        type: integer
                                                      value:
                                                        example: Uren
                                                        nullable: false
                                                        readOnly: true
                                                        type: string
                                                    readOnly: true
                                                    type: object
                                                  column:
                                                    description: |
                                                      The wage sheet column (kolom) of the payroll component. Kolommen are related to its specific lines on the payslip and/or wage sheet.  Also this does bear some similiarties to wage sheets columns (loonstaatkolommen) used by the Belastingdienst, however the division of columns as used by Loket is not identical to that.
                                                    format: metadata
                                                    nullable: false
                                                    properties:
                                                      key:
                                                        example: 6
                                                        format: int32
                                                        nullable: false
                                                        readOnly: true
                                                        type: integer
                                                      value:
                                                        example: Sociaalplichtig loon
                                                        nullable: false
                                                        readOnly: true
                                                        type: string
                                                    readOnly: true
                                                    type: object
                                                  costsEmployer:
                                                    description: |
                                                      Indicates whether the components are costs for the employer (+) or negative costs (-, i.e. benefit) for the employer. The value could also be NULL meaning that the component is not related to actual expenses.
                                                    format: metadata
                                                    nullable: true
                                                    properties:
                                                      key:
                                                        example: 1
                                                        format: int32
                                                        nullable: false
                                                        readOnly: true
                                                        type: integer
                                                      value:
                                                        example: +
                                                        nullable: false
                                                        readOnly: true
                                                        type: string
                                                    readOnly: true
                                                    type: object
                                                  key:
                                                    description: |
                                                      The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart.
                                                    example: 1
                                                    format: int32
                                                    nullable: false
                                                    readOnly: false
                                                    type: integer
                                                  value:
                                                    description: |
                                                      The description of the payroll component
                                                    example: Uren gewerkt
                                                    maxLength: 14
                                                    nullable: false
                                                    readOnly: true
                                                    type: string
                                                type: object
                                              value:
                                                description: Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this.
                                                example: 40
                                                nullable: false
                                                readOnly: true
                                                type: number
                                              valueSpecialTariff:
                                                description: Value/ amount (speciaal tarief voor belasting) for the payrollcomponent. Both a 'normal' and 'special tariff' type payslip may a value for this. Also, both valueNormal and valueSpecialTariff may have a value at the same time.
                                                example: 144
                                                nullable: false
                                                readOnly: true
                                                type: number
                                            type: object
                                          type: array
                                        payslipType:
                                          description: |
                                            The type of payslip on which underlying payroll run results will be booked. This is either normaal or bijzonder tarief.
                                          format: metadata
                                          nullable: false
                                          properties:
                                            key:
                                              example: 1
                                              format: int32
                                              nullable: false
                                              readOnly: true
                                              type: integer
                                            value:
                                              example: Normaal strook
                                              nullable: false
                                              readOnly: true
                                              type: string
                                          readOnly: true
                                          type: object
                                      type: object
                                    type: array
                                type: object
                              type: array
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payroll results for the given payroll period
      tags:
        - Payroll results
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview":
    get:
      description: |
        __Activity name :__ GetPayrollProcessOverviewByPayrollAdministrationId

        Get an overview of the status and possible actions for the specified period, including the preceding and subsequent period. The overview contains information about: payroll runs, payroll tax return and pension.
        __Metadata :__  Possible options for the query string parameters can be acquired (GET) via the `/metadata` endpoint.  The URI for this endpoint is `../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview/metadata`.

        __Defaults :__ Default values for the query string parameters can be acquired via the `/defaults` endpoint.  The URI for this endpoint is `../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview/defaults`.
      operationId: GetPayrollProcessOverviewByPayrollAdministrationId
      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 <TOKEN>
            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 first payroll period to return
          example: 202004
          in: query
          name: payrollPeriodIdStart
          required: true
          schema:
            format: int32
            type: integer
        - description: The unique identifier of the last payroll period to return
          example: 202006
          in: query
          name: payrollPeriodIdEnd
          required: false
          schema:
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            journal:
                              description: Status and possible actions of the journal process
                              nullable: false
                              properties:
                                journalPossibleActions:
                                  description: |
                                    Possible actions for the journal process in the period.
                                    Possible actions are:
                                    - 0	None (no action possible)
                                    - 1	Start
                                    - 2 Export
                                  format: metadata
                                  nullable: false
                                  properties:
                                    journalPossibleActionsAdditionalInfo:
                                      description: |
                                        Additional information on the possible action of the journal process in the period.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          example: "0.7"
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        value:
                                          example: The period has a journalrun queued.
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    key:
                                      example: 0
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    value:
                                      example: None
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                journalStatus:
                                  description: |
                                    Status of the journal process in the period.
                                    Possible statuses are:
                                    - 0	Invalid
                                    - 1	Queued
                                    - 2	Exporting
                                    - 3	Incorrect
                                    - 4	Incorrect and preceding journalrun
                                    - 5	No results
                                    - 6	No results and preceding journalrun 
                                    - 7	Last export failed
                                    - 8	Journal ready
                                    - 9 Export failed
                                    - 10 Not started
                                    - 11 Exported
                                  format: metadata
                                  nullable: false
                                  properties:
                                    journalStatusAdditionalInfo:
                                      description: |
                                        Additional information on the the status of the payroll process in the period.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          example: "2.1"
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        value:
                                          example: The period has a journalrun ready for export
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    value:
                                      example: Queued
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                              type: object
                            payroll:
                              description: Status and possible actions of the payroll process
                              nullable: false
                              properties:
                                payrollPossibleActions:
                                  description: |
                                    Possible actions for the payroll process in the period.
                                    Possible actions are:
                                    - 0	None (no action possible)
                                    - 1	Ready to proces
                                    - 2	Start
                                    - 3	Restart
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 0
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    payrollPossibleActionsAdditionalInfo:
                                      description: |
                                        Additional information on the possible action of the payroll process in the period.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          example: "0.7"
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        value:
                                          example: The period has a payrollrun queued.
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    value:
                                      example: None
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                payrollStatus:
                                  description: |
                                    Status of the payroll process in the period.
                                    Possible statuses are:
                                    - 0	Invalid
                                    - 1	Not started
                                    - 2	Queued
                                    - 3	Waiting for approval
                                    - 4	Incorrect and there is an approved preceding payrollrun
                                    - 5	Incorrect
                                    - 6	Approved 
                                    - 7	No results
                                    - 8	No results and there is an approved preceding payrollrun
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    payrollStatusAdditionalInfo:
                                      description: |
                                        Additional information on the the status of the payroll process in the period.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          example: "2.1"
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        value:
                                          example: The period has a payrollrun queued.
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    value:
                                      example: Queued
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                typeOfInitiationLastPayrollRun:
                                  description: Indicates whether the run is completed with or withour employments.
                                  enum:
                                    - regular
                                    - withoutEmploymentData
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            payrollPeriod:
                              format: metadata
                              nullable: false
                              properties:
                                payrollPeriodId:
                                  description: |
                                    The year and period of the payroll period
                                  example: 202004
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                periodEndDate:
                                  description: |
                                    The last day of the period to which the payroll period data applies
                                  example: 2020-06-30
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                periodNumber:
                                  description: |
                                    The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53])
                                  example: 4
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                periodStartDate:
                                  description: |
                                    The first day of the period to which the payroll period data applies
                                  example: 2020-04-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                year:
                                  description: |
                                    The year of the payroll period
                                  example: 2020
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              readOnly: true
                              type: object
                            payrollTaxReturn:
                              description: Status and possible actions of the payroll taxReturn process
                              nullable: false
                              properties:
                                payrollTaxReturnPossibleActions:
                                  description: |
                                    Possible actions for the payroll tax return process in the period.
                                    Possible actions are:
                                    - 0	None (no action possible)
                                    - 1	Ready to proces
                                    - 2	Start
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    payrollTaxReturnPossibleActionsAdditionalInfo:
                                      description: |
                                        Additional information on the possible action of the payroll tax return process in the period.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          example: "0.13"
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        value:
                                          example: There is a queued payrolltaxreturn.
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    value:
                                      example: Start
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                payrollTaxReturnStatus:
                                  description: |
                                    Status of the payroll taxreturn process in the period.
                                    Possible statuses are: 
                                    - 0	Invalid
                                    - 1	Not started
                                    - 2	Queued
                                    - 3	Waiting for approval
                                    - 5	Incorrect
                                    - 6	Approved
                                    - 9	Approved and sent
                                    - 10	Not available
                                    - 11	Cancelled
                                    - 12	Deleted
                                    - 13	Blank
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 6
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    payrollTaxReturnStatusAdditionalInfo:
                                      description: |
                                        Additional information on the status of the payroll tax return process in the period.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          example: "2"
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        value:
                                          example: The period has a payrolltaxrun queued.
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    value:
                                      example: Done
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                              type: object
                            pensionDeclaration:
                              description: Status and possible actions of the pensiondeclaration process
                              nullable: false
                              properties:
                                pensionAdministratorType:
                                  description: The type of Pension declaration
                                  enum:
                                    - UPA
                                    - APG
                                  nullable: false
                                  readOnly: false
                                  type: string
                                pensionDeclarationPossibleActions:
                                  description: |
                                    Possible actions for the pensiondeclaration process in the period.
                                    Possible actions are:
                                    - 0	None (no action possible)
                                    - 1	Ready to proces
                                    - 2	Start
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    pensionDeclarationPossibleActionsAdditionalInfo:
                                      description: |
                                        Additional information on the possible action of the pensiondeclaration process in the period.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          example: UPAC014
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        value:
                                          example: There is a queued pensiondeclaration.
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    value:
                                      example: Start
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                pensionDeclarationStatus:
                                  description: |
                                    Status of the pensiondeclaration process in the period.
                                    Possible statuses are: 
                                    - 0	Invalid
                                    - 1	Not started
                                    - 2	Queued
                                    - 3	Waiting for approval
                                    - 5	Incorrect
                                    - 6	Approved
                                    - 9	Approved and sent
                                    - 10	Not available
                                    - 11	Cancelled
                                    - 12	Deleted
                                    - 13	Blank
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 6
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    pensionDeclarationStatusAdditionalInfo:
                                      description: |
                                        Additional information on the status of the pensiondeclaration process in the period.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          example: "2"
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        value:
                                          example: The period has a pensiondeclaration queued.
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    value:
                                      example: Done
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Process Information about a payroll on administration level
      tags:
        - Payroll administration process overview
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollruns":
    get:
      description: |
        __Activity name :__ GetPayrollRunsByPayrollAdministrationId

        A list of payroll runs for an administration
      operationId: GetPayrollRunsByPayrollAdministrationId
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            approvalTime:
                              description: The time at which the payroll run was approved by the user
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            approvedBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            availableForEmployeeDate:
                              description: The date on which the pay slips will be available to employees.
                              example: 2018-05-08
                              format: date
                              nullable: true
                              readOnly: false
                              type: string
                            errorsAndWarnings:
                              nullable: false
                              properties:
                                hasErrors:
                                  description: Indicates whether the payrollrun has errors
                                  nullable: false
                                  readOnly: true
                                  type: boolean
                                hasWarnings:
                                  description: Indicates whether the payrollrun has warnings
                                  example: true
                                  nullable: false
                                  readOnly: true
                                  type: boolean
                              readOnly: true
                              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
                            methodOfCreation:
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: The key indicating how the payroll run was created.
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  description: The value describing how the payroll run was created.
                                  example: Individueel
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            payrollPeriod:
                              format: metadata
                              properties:
                                periodEndDate:
                                  description: The last day of the period for which the tax return message was created
                                  example: 2018-01-31
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                periodNumber:
                                  description: The period number of the payroll period the record relates to
                                  example: 1
                                  format: int32
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                periodStartDate:
                                  description: The first day of the period for which the tax return message was created
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                testYear:
                                  description: |-
                                    Indicates whether the payroll periode is part of a test year.

                                    In Loket it is possible to run a year of a payrolladministration as a so-called test year.  This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. 
                                    Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
                                  example: false
                                  nullable: false
                                  readOnly: true
                                  type: boolean
                                year:
                                  description: The year of the payroll period the record relates to
                                  example: 2017
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            payrollRunStatus:
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: The key indicating the current status of the payroll run.
                                  example: 9
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  description: |
                                    The value describing the current status of the payroll run.
                                    * Staat klaar voor verloning. (key = 0)
                                    * Verloning gereed. (key = 1)
                                    * Proforma verloning gereed. (key = 2)
                                    * Verwijderd door gebruiker (key = 5)
                                    * Verloning geannuleerd door gebruiker. (key = 6)
                                    * Fout tijdens verloning. (key = 7)
                                    * Geen loonresultaten, verloning geannuleerd. (key = 8)
                                    * Verloning goedgekeurd. (key = 9)
                                  example: Verloning goedgekeurd.
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            processingFinishedTime:
                              description: Date-time when the calculations of the wages was finished
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            removeTime:
                              description: The time at which the pay roll run was removed.
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            removedBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            requestTime:
                              description: The time at which the payroll run was requested by the user
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            requestedBy:
                              format: metadata
                              nullable: false
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            sendEmailToEmployee:
                              description: Indicates whether an email should be sent to the employees when the pay slip is available to them.
                              nullable: false
                              readOnly: false
                              type: boolean
                            sequenceNumber:
                              description: An incremental number with a payrolling year to uniquely identify a payroll run. Null can be returned for those runs that dont contain "wages".
                              example: 1
                              format: int32
                              nullable: true
                              readOnly: true
                              type: integer
                            sequenceNumberApproved:
                              description: An incremental number with a payrolling year to uniquely identify an approved payroll run.
                              format: int32
                              nullable: true
                              readOnly: true
                              type: integer
                            textPaySlip:
                              description: An optional text provided by an authorized user that will be displayed on the pay slip.
                              maxLength: 25
                              nullable: true
                              readOnly: false
                              type: string
                            textPayment:
                              description: An optional text provided by an authorized user that will be displayed as a description for the payment.
                              maxLength: 32
                              nullable: true
                              readOnly: false
                              type: string
                            textTariffPaySlip:
                              description: An additional text to  be displayed on the tariff payslip.
                              maxLength: 25
                              nullable: true
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payroll runs for an administration
      tags:
        - Payroll run
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollruns/initiate":
    post:
      description: |-
        __Activity name :__ PostInitiatePayrollRunByPayrollAdministrationId This is a controller endpoint to perform an action.

        In the older Loket GUI this specific action is referred to as respectively 'Verlonen' / 'Verlonen periode zonder personeel' / 'Verlonen voorgaande jaren' . If this action is performed succesfully then the payroll run will be created with status 0 and will be cued for further processing. The further processing depends on the input parameters and the payroll configuration in the given situation. After the initiated run has been picked up and processed by the background process, then the status of the run will be changed accordingly.

        This action may be performed for all payroll periods that are *available for the payroll administration* AND that meet one of the following requirements;

        If typeOfInitiation = 'regular' (Verlonen);
        * The very last payroll period for which an approved payroll run (status = 9) is available. Within the given year of payrolling. (This would functionally be a so-called 'correction' run)
        * The very first payroll period in time that does not yet have an approved payroll run (i.e. last payroll period with approved run + 1). Within the given year of payrolling, if available
        * The provided year may be a maximum of 7 years in the past (based on current datetime)

        If typeOfInitiation = 'withoutEmploymentData' (Verlonen zonder personeel);
        * The very first payroll period in time that does not yet have an approved payroll run (i.e. last payroll period with approved run + 1). Within the active year of payrolling
        * Please note that if this type is selected then the following fields must ALL be set to null; sendEmailToEmployee, textPaySlip, textTariffPaySlip, textPayment, emailAdressPayrollRunStarted, emailFinishedPayrollRun


        In general;
        * It is not possible to initiate a new payroll run if there is currently a payroll run with status 0  (to be processed) or 1 (awaiting approval) within the payroll administation.


        __Metadata :__  No metadata endpoint available for this controller endpoint.

        __Defaults :__ Defaults endpoint is available for this controller endpoint by adding /defaults. Also, an endpoint is available to retrieve initiation values for a specific period.
      operationId: PostInitiatePayrollRunByPayrollAdministrationId
      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 <TOKEN>
            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:
                - properties:
                    approvalTime:
                      description: The time at which the payroll run was approved by the user
                      example: 2018-05-08T15:16:49+02:00
                      format: date-time
                      nullable: true
                      readOnly: true
                      type: string
                    approvedBy:
                      format: metadata
                      nullable: true
                      properties:
                        formattedName:
                          description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                          example: Jong, I
                          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 user
                          example: I
                          maxLength: 6
                          nullable: false
                          readOnly: true
                          type: string
                        lastName:
                          description: The last name of the user
                          example: Jong
                          maxLength: 25
                          nullable: false
                          readOnly: true
                          type: string
                        prefix:
                          description: The prefix of the user
                          example: de
                          maxLength: 10
                          nullable: true
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    availableForEmployeeDate:
                      description: The date on which the pay slips will be available to employees.
                      example: 2018-05-08
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    errorsAndWarnings:
                      nullable: false
                      properties:
                        hasErrors:
                          description: Indicates whether the payrollrun has errors
                          nullable: false
                          readOnly: true
                          type: boolean
                        hasWarnings:
                          description: Indicates whether the payrollrun has warnings
                          example: true
                          nullable: false
                          readOnly: true
                          type: boolean
                      readOnly: true
                      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
                    methodOfCreation:
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          description: The key indicating how the payroll run was created.
                          example: 2
                          format: int32
                          nullable: false
                          readOnly: true
                          type: integer
                        value:
                          description: The value describing how the payroll run was created.
                          example: Individueel
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    payrollPeriod:
                      format: metadata
                      properties:
                        periodEndDate:
                          description: The last day of the period for which the tax return message was created
                          example: 2018-01-31
                          format: date
                          nullable: false
                          readOnly: true
                          type: string
                        periodNumber:
                          description: The period number of the payroll period the record relates to
                          example: 1
                          format: int32
                          nullable: true
                          readOnly: false
                          type: integer
                        periodStartDate:
                          description: The first day of the period for which the tax return message was created
                          example: 2018-01-01
                          format: date
                          nullable: false
                          readOnly: true
                          type: string
                        testYear:
                          description: |-
                            Indicates whether the payroll periode is part of a test year.

                            In Loket it is possible to run a year of a payrolladministration as a so-called test year.  This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. 
                            Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
                          example: false
                          nullable: false
                          readOnly: true
                          type: boolean
                        year:
                          description: The year of the payroll period the record relates to
                          example: 2017
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                      type: object
                    payrollRunStatus:
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          description: The key indicating the current status of the payroll run.
                          example: 9
                          format: int32
                          nullable: false
                          readOnly: true
                          type: integer
                        value:
                          description: |
                            The value describing the current status of the payroll run.
                            * Staat klaar voor verloning. (key = 0)
                            * Verloning gereed. (key = 1)
                            * Proforma verloning gereed. (key = 2)
                            * Verwijderd door gebruiker (key = 5)
                            * Verloning geannuleerd door gebruiker. (key = 6)
                            * Fout tijdens verloning. (key = 7)
                            * Geen loonresultaten, verloning geannuleerd. (key = 8)
                            * Verloning goedgekeurd. (key = 9)
                          example: Verloning goedgekeurd.
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    processingFinishedTime:
                      description: Date-time when the calculations of the wages was finished
                      example: 2018-05-08T15:16:49+02:00
                      format: date-time
                      nullable: true
                      readOnly: true
                      type: string
                    removeTime:
                      description: The time at which the pay roll run was removed.
                      example: 2018-05-08T15:16:49+02:00
                      format: date-time
                      nullable: true
                      readOnly: true
                      type: string
                    removedBy:
                      format: metadata
                      nullable: true
                      properties:
                        formattedName:
                          description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                          example: Jong, I
                          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 user
                          example: I
                          maxLength: 6
                          nullable: false
                          readOnly: true
                          type: string
                        lastName:
                          description: The last name of the user
                          example: Jong
                          maxLength: 25
                          nullable: false
                          readOnly: true
                          type: string
                        prefix:
                          description: The prefix of the user
                          example: de
                          maxLength: 10
                          nullable: true
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    requestTime:
                      description: The time at which the payroll run was requested by the user
                      example: 2018-05-08T15:16:49+02:00
                      format: date-time
                      nullable: false
                      readOnly: true
                      type: string
                    requestedBy:
                      format: metadata
                      nullable: false
                      properties:
                        formattedName:
                          description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                          example: Jong, I
                          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 user
                          example: I
                          maxLength: 6
                          nullable: false
                          readOnly: true
                          type: string
                        lastName:
                          description: The last name of the user
                          example: Jong
                          maxLength: 25
                          nullable: false
                          readOnly: true
                          type: string
                        prefix:
                          description: The prefix of the user
                          example: de
                          maxLength: 10
                          nullable: true
                          readOnly: true
                          type: string
                      readOnly: true
                      type: object
                    sendEmailToEmployee:
                      description: Indicates whether an email should be sent to the employees when the pay slip is available to them.
                      nullable: false
                      readOnly: false
                      type: boolean
                    sequenceNumber:
                      description: An incremental number with a payrolling year to uniquely identify a payroll run. Null can be returned for those runs that dont contain "wages".
                      example: 1
                      format: int32
                      nullable: true
                      readOnly: true
                      type: integer
                    sequenceNumberApproved:
                      description: An incremental number with a payrolling year to uniquely identify an approved payroll run.
                      format: int32
                      nullable: true
                      readOnly: true
                      type: integer
                    textPaySlip:
                      description: An optional text provided by an authorized user that will be displayed on the pay slip.
                      maxLength: 25
                      nullable: true
                      readOnly: false
                      type: string
                    textPayment:
                      description: An optional text provided by an authorized user that will be displayed as a description for the payment.
                      maxLength: 32
                      nullable: true
                      readOnly: false
                      type: string
                    textTariffPaySlip:
                      description: An additional text to  be displayed on the tariff payslip.
                      maxLength: 25
                      nullable: true
                      readOnly: false
                      type: string
                  type: object
                - properties:
                    initiationParameters:
                      nullable: false
                      properties:
                        emailAddressPayrollRunFinished:
                          description: The e-mail address to which an email will be sent when the payroll run is finished. (Email gereed)
                          example: info@loket.nl
                          maxLength: 255
                          nullable: true
                          readOnly: false
                          type: string
                        emailAddressPayrollRunStarted:
                          description: The e-mail address to which an email will be sent when the payroll run is started. (Email starten)
                          example: info@loket.nl
                          maxLength: 255
                          nullable: true
                          readOnly: false
                          type: string
                        typeOfInitiation:
                          enum:
                            - regular
                            - withoutEmploymentData
                          nullable: false
                          readOnly: false
                          type: string
                      type: object
        description: Initiate Payroll Run Payload.
        required: true
      responses:
        "202":
          content:
            application/json;version=2018-01-01:
              schema:
                allOf:
                  - properties:
                      content:
                        properties:
                          id:
                            description: The unique identifier (GUID/UUID) of the payroll run.
                            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
          description: Accepted
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Initiate payroll run (verlonen)
      tags:
        - Initiate payroll run
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollruns/{periodId}/initiationvalues":
    get:
      description: |
        __Activity name :__ GetPayrollrunInitiationvaluesByPayrollAdministrationIdAndPeriodId 

        Get the initiation values for initiating a payrollrun for a specific period.
      operationId: GetPayrollrunInitiationvaluesByPayrollAdministrationIdAndPeriodId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 payroll run
          in: query
          name: payrollrunId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of the payroll period
          example: "202103"
          in: query
          name: payrollPeriodId
          required: true
          schema:
            format: int32
            type: integer
        - description: Automatically added
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            type: string
        - description: Automatically added
          in: path
          name: periodId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          availableForEmployeeDate:
                            description: The date on which the pay slips will be available to employees.
                            example: 2021-05-08
                            format: date
                            nullable: true
                            readOnly: true
                            type: string
                          emailAddressPayrollRunApproved:
                            description: The email address to send an email to, after starting the payroll run has been approved."
                            nullable: true
                            readOnly: true
                            type: string
                          emailAddressPayrollRunFinished:
                            description: The email address to send an email to, after the payroll run has been calculated.
                            nullable: true
                            readOnly: true
                            type: string
                          emailAddressPayrollRunStarted:
                            description: The email address to send an email to, after starting the payroll run proces.
                            nullable: true
                            readOnly: true
                            type: string
                          payrollPeriod:
                            format: metadata
                            properties:
                              periodEndDate:
                                description: The last day of the period for which the tax return message was created
                                example: 2018-01-31
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              periodNumber:
                                description: The period number of the payroll period the record relates to
                                example: 1
                                format: int32
                                nullable: true
                                readOnly: false
                                type: integer
                              periodStartDate:
                                description: The first day of the period for which the tax return message was created
                                example: 2018-01-01
                                format: date
                                nullable: false
                                readOnly: true
                                type: string
                              testYear:
                                description: |-
                                  Indicates whether the payroll periode is part of a test year.

                                  In Loket it is possible to run a year of a payrolladministration as a so-called test year.  This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. 
                                  Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.
                                example: false
                                nullable: false
                                readOnly: true
                                type: boolean
                              year:
                                description: The year of the payroll period the record relates to
                                example: 2017
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                            type: object
                          sendEmailToEmployee:
                            description: Indicates whether an email should be sent to the employees when the pay slip is available to them.
                            nullable: false
                            readOnly: true
                            type: boolean
                        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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Initiationvalues of a payrollrun
      tags:
        - Initiate payroll run
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/payrolltaxreturns":
    get:
      description: |
        __Activity name :__ GetPayrollTaxReturnsByPayrollAdministrationId

        A list of tax returns for an administration
      operationId: GetPayrollTaxReturnsByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 administration
          in: path
          name: payrollAdministrationId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            approvalTime:
                              description: The time at which the payroll tax return run was approved by the user
                              example: 2021-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            approvedBy:
                              format: metadata
                              nullable: false
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            cancelledBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            cancelledTime:
                              description: The time at which the pay roll run was cancelled. (Annuleren)
                              example: 2021-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            correctionAmount:
                              description: The amount, in euro's, of wage tax to be paid as correction for previous period(s)
                              example: 500
                              nullable: false
                              readOnly: true
                              type: number
                            deadlineForPayment:
                              description: The final date at which the amount is due.
                              example: 2021-12-31
                              format: date
                              nullable: false
                              readOnly: true
                              type: string
                            emailAddressPayrollTaxReturnRunStarted:
                              description: The e-mail address to which an email will be sent when the payroll tax return run is started. (Email starten)
                              example: info@loket.nl
                              nullable: true
                              readOnly: true
                              type: string
                            externalIdentification:
                              description: An identifier to be filled by external parties after submitting the tax return.
                              example: AA123
                              nullable: true
                              readOnly: true
                              type: string
                            iban:
                              description: The IBAN to which the payroll tax return should be payed. Only IBAN without spaces are accepted.
                              example: NL86INGB0002445588
                              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
                            inTheNameOf:
                              description: The name of the benificiary corresponding with the IBAN
                              example: tnv belastingdienst Apeldoorn
                              nullable: false
                              readOnly: true
                              type: string
                            isCorrectionMessagePriorYear:
                              description: |
                                Indicates whether the payroll tax return is a correction message or not. A correction message is always for a prior year and no SEPA file can be downloaded for a correction message.  
                              example: true
                              nullable: false
                              readOnly: false
                              type: boolean
                            messageCreationTime:
                              description: Date-time when the message was created
                              example: 2021-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            messageReference:
                              description: |
                                The message reference (berichtkenmerk) that is used within the payroll tax return message.
                              example: VSP001111111110L29000035201302
                              nullable: false
                              readOnly: true
                              type: string
                            methodOfCreation:
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: The key indicating how the payroll tax return run was created.
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  description: The value describing how the payroll tax return run was created.
                                  example: Individueel
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            paymentReference:
                              description: The payment reference (betalingskenmerk) to be used when making the payment to the tax office.
                              example: "8111111116529080"
                              nullable: false
                              readOnly: true
                              type: string
                            payrollPeriodType:
                              description: Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4).
                              nullable: false
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: month
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            payrollTaxReturnParty:
                              description: Indicates the party submitting the tax return.
                              nullable: false
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: Loket.nl
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            payrollTaxReturnStatus:
                              description: |
                                The current status of the tax return
                                Possible values:

                                * Verzoek tot aanmaak loonaangifte (key = 1)
                                * Fout bij aanmaken loonaangifte (key = 2)
                                * Loonaangifte aangemaakt (key = 3)
                                * Loonaangifte geannuleerd (key = 4)
                                * Loonaangifte bevestigd (key = 5)
                                * Loonaangifte verzonden (key = 6)
                                * Loonaangifte verwijderd (key = 7)
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 3
                                  format: int32
                                  type: integer
                                value:
                                  example: Loonaangifte aangemaakt
                                  type: string
                              readOnly: true
                              type: object
                            payrollTaxReturnType:
                              description: Indicates the frequence of the payrol tax retun process. Can be each payroll period or annually.
                              nullable: false
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: Periodeaangifte
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            period:
                              format: metadata
                              properties:
                                periodEndDate:
                                  description: The last day of the period for which the tax return message was created
                                  example: 2018-01-31
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                periodNumber:
                                  description: The period number of the payroll period for which the tax return was created. In case of a yearly tax return this value will be set to 0
                                  example: 1
                                  format: int32
                                  nullable: true
                                  readOnly: true
                                  type: integer
                                periodStartDate:
                                  description: The first day of the period for which the tax return message was created
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                year:
                                  description: The year of the period for which the tax return message was created.
                                  example: 2017
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              type: object
                            periodAmount:
                              description: The amount, in euro's, of wage tax to be paid for this period
                              example: 2000
                              nullable: false
                              readOnly: true
                              type: number
                            processingFinishedTime:
                              description: Date-time when the calculations were finished
                              example: 2021-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            removalTime:
                              description: The time at which the payroll tax return run was removed (verwijderd by the user
                              example: 2021-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            removedBy:
                              format: metadata
                              nullable: false
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            requestTime:
                              description: The time at which the payroll tax return run was requested by the user
                              example: 2021-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            requestedBy:
                              format: metadata
                              nullable: false
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            responseMessages:
                              items:
                                properties:
                                  dateOfReceipt:
                                    description: The date on which the response message was received
                                    example: 2016-01-19
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  responseClass:
                                    description: The Walvis class code
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        example: 26
                                        format: int32
                                        type: integer
                                      value:
                                        example: Loonheffingennummer is onjuist
                                        type: string
                                    readOnly: true
                                    type: object
                                  responseType:
                                    description: The response type
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        example: 2
                                        format: int32
                                        type: integer
                                      value:
                                        example: Error
                                        type: string
                                    readOnly: true
                                    type: object
                                type: object
                              type: array
                            sendTime:
                              description: The time at which the payroll tax return run message was send.
                              example: 2021-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            sequenceNumber:
                              description: An incremental number.
                              example: 1
                              format: int32
                              nullable: false
                              readOnly: true
                              type: integer
                            taxReturnMessageReference:
                              description: The name of the party responsible for the payroll tax return
                              example: Bedrijf B.V.
                              nullable: true
                              readOnly: true
                              type: string
                            totalAmount:
                              description: The cumulative ammount of the correctionAmount and periodAmount. Indication the total ammount to be paid for this wagetax return
                              example: 2500
                              nullable: false
                              readOnly: true
                              type: number
                            wageTaxNumber:
                              description: The wage tax number aka Loonheffingennummer.
                              example: 111111110L00
                              maxLength: 12
                              nullable: false
                              readOnly: true
                              type: string
                            withholdingParty:
                              description: The name of the party responsible for the payroll tax return
                              example: Bedrijf B.V.
                              nullable: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 tax returns for an administration
      tags:
        - Payroll tax return
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/payrolltaxreturns/initiate":
    post:
      description: |-
        __Activity name :__ PostInitiatePayrollTaxReturnByPayrollAdministrationId

        This is a controller endpoint to perform an action. 


         __Metadata :__  
         There is a metadata endpoint that will return process information rather then true metadata. 
         This endpoint is available by simply adding /metadata behind the URI.


         __Defaults :__ Default values for a new object can be acquired (GET) by adding `/defaults' to the POST URL. 
      operationId: PostInitiatePayrollTaxReturnByPayrollAdministrationId
      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 <TOKEN>
            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:
                notifyOfInitiation:
                  type: string
              type: object
        description: Initiate payroll tax return.
        required: true
      responses:
        "202":
          content:
            application/json;version=2018-01-01:
              schema:
                allOf:
                  - properties:
                      content:
                        properties:
                          id:
                            description: The unique identifier (GUID/UUID) of the payroll tax return run.
                            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
          description: Accepted
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Initiate payroll tax return (aanmaken loonaangifte)
      tags:
        - Initiate payroll tax return
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/payrolltaxreturns/{payrolltaxreturnId}/sepafile":
    get:
      description: |
        __Activity name :__ GetSepaFileByPayrollAdministrationIdAndPayrollTaxReturnId

        Get the Sepa file for the payroll tax return
      operationId: GetSepaFileByPayrollAdministrationIdAndPayrollTaxReturnId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of the payroll tax return
          in: path
          name: payrolltaxreturnId
          required: true
          schema:
            format: uuid
            type: string
        - description: This value is used when creating the sepa file to set the value of \<ReqdExctnDt\>
          in: query
          name: requestedExecutionDate
          required: true
          schema:
            format: date
            type: string
      responses:
        "200":
          content:
            application/xml:
              schema:
                format: binary
                type: string
          description: OK
          headers:
            Content-Disposition:
              description: |
                The filename
              schema:
                example: inline; filename="SEPA001111111110L29000076201901.xml"
                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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download the SEPA file for a payroll tax return
      tags:
        - Payroll tax return downloads
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/periodreadyforpayroll":
    post:
      description: |
        __Activity name :__ PostPeriodReadyForPayrollByPayrollAdministrationId

        Send an email to inform that the period is ready for payrolling.
      operationId: PostPeriodReadyForPayrollByPayrollAdministrationId
      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 <TOKEN>
            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:
                emailAddressPeriodReadyForPayroll:
                  description: The email address(es) of the recipient(s)
                  example:
                    - email@kantoor.nl
                    - email2@kantoor.nl
                  format: emailAddress
                  items:
                    maxLength: 255
                    pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                    type: string
                  maxItems: 10
                  minItems: 1
                  nullable: false
                  readOnly: false
                  type: array
                payrollPeriodId:
                  description: The id for this specific payroll period.
                  example: 202101
                  format: int32
                  nullable: false
                  readOnly: false
                  type: integer
                userComment:
                  description: A personal message from the sender.
                  example: All mutations are done.
                  maxLength: 1000
                  nullable: true
                  readOnly: false
                  type: string
              type: object
        description: Report period ready for payroll
        required: true
      responses:
        "202":
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Accepted
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Send an email to inform the salary administrator
      tags:
        - Period ready for payroll
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/upapensiondeclarations":
    get:
      description: |
        __Activity name :__ GetUpaPensionDeclarationsByPayrollAdministrationId

        A list of UPA pension declarations for an administration
      operationId: GetUpaPensionDeclarationsByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 administration
          in: path
          name: payrollAdministrationId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            approvalTime:
                              description: The time at which the payroll run was approved by the user
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            approvedBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            cancelledBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            cancelledTime:
                              description: The time at which the payroll run was Cancelled by the user
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            creationTime:
                              description: The time at which the pension message was requested by the user
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            externalParty:
                              description: External party (externe partij)
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 13
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: PFZW (UPA)
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              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
                            messageReference:
                              description: |
                                The message reference (berichtkenmerk) to recognize the given declaration.
                              example: "190"
                              nullable: true
                              readOnly: true
                              type: string
                            methodOfCreation:
                              description: Method by which the creation of the run was triggered.
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Individueel
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            payrollTaxesNumber:
                              description: The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst.
                              example: 111111110L46
                              maxLength: 12
                              minLength: 12
                              nullable: true
                              readOnly: false
                              type: string
                            period:
                              format: metadata
                              nullable: true
                              properties:
                                periodEndDate:
                                  description: The end date of the period
                                  example: 2021-11-30
                                  format: date
                                  nullable: false
                                  readOnly: false
                                  type: string
                                periodId:
                                  description: The periodId of the payroll period.
                                  example: 202101
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                periodNumber:
                                  description: The period number of the payroll period for which the pension declaration was created. In case of a yearly tax return this value will be set to 0
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                periodStartDate:
                                  description: The start date of the period
                                  example: 2021-11-01
                                  format: date
                                  nullable: false
                                  readOnly: false
                                  type: string
                                periodType:
                                  description: Indicates the frequence of the process. Payrolling can be done on a montly, 4-weekly or weekly basis.
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    value:
                                      example: month
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                year:
                                  description: The year of the period for which the pension declaration was created.
                                  example: 2017
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              type: object
                            removeTime:
                              description: The time at which the pay roll run was removed.
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            removedBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            requestTime:
                              description: The time at which the payroll run was requested by the user
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            requestedBy:
                              format: metadata
                              nullable: false
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            responseMessages:
                              items:
                                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: true
                                    type: string
                                  code:
                                    description: The description of the response message
                                    example: NOK
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  datetimeOfMessageReceipt:
                                    description: The date on which the original message was received by the external entity
                                    example: 2016-01-19
                                    format: date-time
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  datetimeOfRegistration:
                                    description: The date on which the response message was registered in Loket
                                    example: 2016-01-19
                                    format: date-time
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  description:
                                    description: The description of the response message
                                    example: De werkgever heeft geen contract voor de opgegeven regeling. Doe opnieuw aangifte zonder deze regeling.
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  descriptionFragment:
                                    description: The description of the response message
                                    example: Het Loonheffingennummer moet bestaan, bekend en in gebruik zijn bij de PUO.
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  employeeNumber:
                                    description: |
                                      The employee number to uniquely identify an employee within an employer
                                    example: 156
                                    format: int32
                                    minimum: 1
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                  errorType:
                                    description: If  there is an error type then this field contain its value.
                                    example: F
                                    nullable: true
                                    readOnly: true
                                    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: false
                                    readOnly: true
                                    type: integer
                                  lineNumber:
                                    description: If  there is an error type then this field contain a value.
                                    example: 14
                                    nullable: true
                                    readOnly: true
                                    type: integer
                                  linePosition:
                                    description: If  there is an error type then this field contain a value.
                                    example: 11
                                    nullable: true
                                    readOnly: true
                                    type: integer
                                  responseStatus:
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        example: 2
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        example: Bericht niet OK (NOK)
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    readOnly: true
                                    type: object
                                  responseType:
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        example: Ontvangstbevestiging (ACK)
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    readOnly: true
                                    type: object
                                type: object
                              type: array
                            sendingPartyNumber:
                              description: |
                                The number of the sending party (i.e. nummer leverancier).
                              example: SWO00077
                              nullable: false
                              readOnly: true
                              type: string
                            sentTime:
                              description: The time at which the pay roll run was sent.
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            upaPensionDeclarationStatus:
                              description: |
                                The current status of the pension declaration

                                Possible values:
                                * Verzoek tot aanmaak pensioenaangifte (key = 1)
                                * Fout bij aanmaken pensioenaangifte (key = 2)
                                * Pensioenaangifte aangemaakt (key = 3)
                                * Pensioenaangifte geannuleerd (key = 4)
                                * Pensioenaangifte bevestigd (key = 5)
                                * Pensioenaangifte verzonden (key = 6)
                                * Pensioenaangifte verwijderd (key = 7)
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 3
                                  format: int32
                                  type: integer
                                value:
                                  example: Pensioenaangifte aangemaakt
                                  type: string
                              readOnly: true
                              type: object
                            withholdingAgentName:
                              description: |
                                The withholding agent name (naam inhoudingsplichtige) for this return.
                              example: Ben-Hur BV Via Roma
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 UPA pension declarations
      tags:
        - Upa pension declaration
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/upapensiondeclarations/initiate":
    post:
      description: |
        __Activity name :__ PostInitiateUpaPensionDeclarationByPayrollAdministrationId

        Initiate the pension declaration for the next available period for the payrolladministration. Information about the next available periode can be obtained using the defaults endpoint (/defaults) 
      operationId: PostInitiateUpaPensionDeclarationByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "202":
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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)
                            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: Accepted
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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 a UPA pension declaration
      tags:
        - Upa pension declaration
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/yearendstatements":
    get:
      description: |
        __Activity name :__ GetYearEndStatementsByPayrollAdministrationId

        Get a list of year-end statements (i.e. list of years for which year-end statements are available) for a payrolladministration.

        The year-end statements at administration level are effectively a collection of year-end statements for its underlying employments. However it may also be required at the administration level in one call.
      operationId: GetYearEndStatementsByPayrollAdministrationId
      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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            year:
                              description: The year for which a year-end statement is available.
                              example: 2018
                              format: int32
                              nullable: false
                              readOnly: true
                              type: integer
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Year-end statements for the payroll administration
      tags:
        - Year-end statement at administration level
  "/providers/employers/payrolladministrations/{payrollAdministrationId}/yearendstatements/{year}":
    get:
      description: |
        __Activity name :__ GetYearEndStatementForYearByPayrollAdministrationId

        Download the year-end statements of a payroll administration (of its underlying employment) for a year.

        The year-end statements at administration level are effectively a collection of year-end statements for its underlying employments. With this endpoint it may also be required at the administration level in one call.

        _Please note: this endpoint may only be used to acquire a report in the pdf-type format_ 
      operationId: GetYearEndStatementForYearByPayrollAdministrationId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 administration
          in: path
          name: payrollAdministrationId
          required: true
          schema:
            format: uuid
            type: string
        - description: The payroll year
          in: path
          name: year
          required: true
          schema:
            example: 2018
            format: int32
            maxLength: 4
            type: integer
        - description: If true; then the year-end statements for employments of which the employee has access to the employee self service module will be included in the response. If false; this specific group will be excluded.
          example: true
          in: query
          name: includeEmployeeSelfService
          required: false
          schema:
            type: boolean
      responses:
        "200":
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download year-end statement of a payroll administration for a year
      tags:
        - Year-end statement at administration level
  /providers/employers/users/downloadrequests:
    get:
      description: |
        __Activity name:__ GetDownloadRequestsByBearerToken
            

        Get the list of download requests for an employment

        __Note:__ The module (product) has to be activited for all the employers the user has access to. The same holds true for the permissions (rechten) of the users for these employers.
      operationId: GetDownloadRequestsByBearerToken
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: false
                          properties:
                            downloadRequestStatus:
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: The key indicating the current status of the download request.
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: Bestand aangemaakt
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            expirationTime:
                              description: The time at which the download will expire.
                              example: 2018-05-16T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            filename:
                              description: |
                                The name of the download file.
                              example: WerkgeverDownload.rar
                              maxLength: 4000
                              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
                            latestDownloadTime:
                              description: The time of the most recent download.
                              example: 2018-05-09T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            processingFinishedTime:
                              description: The time when the download become available.
                              example: 2018-05-09T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            requestTime:
                              description: The time at which the download request was created by the user
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            year:
                              description: The year of the download request relates to
                              example: 2017
                              format: int32
                              maximum: 9999
                              minimum: 2000
                              nullable: false
                              readOnly: false
                              type: integer
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 download requests for an employment
      tags:
        - Download request
    post:
      description: |
        __Activity name:__ PostDownloadRequestByBearerToken
            

        Create a download request for an employment
      operationId: PostDownloadRequestByBearerToken
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: false
              properties:
                downloadRequestStatus:
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      description: The key indicating the current status of the download request.
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    value:
                      example: Bestand aangemaakt
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                expirationTime:
                  description: The time at which the download will expire.
                  example: 2018-05-16T15:16:49+02:00
                  format: date-time
                  nullable: true
                  readOnly: true
                  type: string
                filename:
                  description: |
                    The name of the download file.
                  example: WerkgeverDownload.rar
                  maxLength: 4000
                  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
                latestDownloadTime:
                  description: The time of the most recent download.
                  example: 2018-05-09T15:16:49+02:00
                  format: date-time
                  nullable: true
                  readOnly: true
                  type: string
                processingFinishedTime:
                  description: The time when the download become available.
                  example: 2018-05-09T15:16:49+02:00
                  format: date-time
                  nullable: true
                  readOnly: true
                  type: string
                requestTime:
                  description: The time at which the download request was created by the user
                  example: 2018-05-08T15:16:49+02:00
                  format: date-time
                  nullable: false
                  readOnly: true
                  type: string
                year:
                  description: The year of the download request relates to
                  example: 2017
                  format: int32
                  maximum: 9999
                  minimum: 2000
                  nullable: false
                  readOnly: false
                  type: integer
              type: object
        description: Download request to add to the employment.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          downloadRequestStatus:
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: The key indicating the current status of the download request.
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Bestand aangemaakt
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          expirationTime:
                            description: The time at which the download will expire.
                            example: 2018-05-16T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          filename:
                            description: |
                              The name of the download file.
                            example: WerkgeverDownload.rar
                            maxLength: 4000
                            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
                          latestDownloadTime:
                            description: The time of the most recent download.
                            example: 2018-05-09T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          processingFinishedTime:
                            description: The time when the download become available.
                            example: 2018-05-09T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          requestTime:
                            description: The time at which the download request was created by the user
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          year:
                            description: The year of the download request relates to
                            example: 2017
                            format: int32
                            maximum: 9999
                            minimum: 2000
                            nullable: false
                            readOnly: false
                            type: integer
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 download request
      tags:
        - Download request
  "/providers/employers/users/downloadrequests/{downloadRequestId}":
    delete:
      description: |
        __Activity name:__ DeleteDownloadRequestByDownloadRequestId

        Delete a download request for the employment
      operationId: DeleteDownloadRequestByDownloadRequestId
      parameters:
        - description: The unique identifier of the downloadRequest
          in: path
          name: downloadRequestId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 download request record
      tags:
        - Download request
    get:
      description: |
        __Activity name:__ GetDownloadRequestByDownloadRequestId

        Get the details of a download request record
      operationId: GetDownloadRequestByDownloadRequestId
      parameters:
        - description: The unique identifier of the downloadRequest
          in: path
          name: downloadRequestId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          downloadRequestStatus:
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: The key indicating the current status of the download request.
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Bestand aangemaakt
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          expirationTime:
                            description: The time at which the download will expire.
                            example: 2018-05-16T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          filename:
                            description: |
                              The name of the download file.
                            example: WerkgeverDownload.rar
                            maxLength: 4000
                            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
                          latestDownloadTime:
                            description: The time of the most recent download.
                            example: 2018-05-09T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          processingFinishedTime:
                            description: The time when the download become available.
                            example: 2018-05-09T15:16:49+02:00
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          requestTime:
                            description: The time at which the download request was created by the user
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          year:
                            description: The year of the download request relates to
                            example: 2017
                            format: int32
                            maximum: 9999
                            minimum: 2000
                            nullable: false
                            readOnly: false
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 download request record
      tags:
        - Download request
  "/providers/employers/users/downloadrequests/{downloadRequestId}/file":
    get:
      description: |
        __Activity name:__ GetFileByDownloadRequestId

        Download the file of a download request record
      operationId: GetFileByDownloadRequestId
      parameters:
        - description: The unique identifier of the downloadRequest
          in: path
          name: downloadRequestId
          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 <TOKEN>
            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/vnd.rar:
              schema:
                format: binary
                type: string
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Download file of download request
      tags:
        - Download request
  "/providers/employers/users/{employerUserId}/configuredexternaltenant":
    get:
      description: |
        __Activity name :__ GetConfiguredExternalTenantByEmployerUserId


         Get the external tenant that is configured for this specific user. 
      operationId: GetConfiguredExternalTenantByEmployerUserId
      parameters:
        - description: The unique identifier of a employer user
          in: path
          name: employerUserId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          externalTenant:
                            nullable: true
                            properties:
                              id:
                                description: The unique identifier (GUID/UUID) of an external tenant.  Input validation; the value of this field MUST match one of the external tenants that is available to this user (check the GetExternalTenants call)
                                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: The user-friendly name of the external tenant
                                example: Loket tenant
                                maxLength: 28
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          externalUser:
                            nullable: true
                            properties:
                              id:
                                description: The unique identifier of an Azure AD user. The id of an user can be found in in Azure AD application. Within this endpoint there is no input validation for this value, but in order to succesfully perform the Azure AD login flow it must correspond with an actual user id within the provided external tenant.
                                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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Configured external tenant for an employer user
      tags:
        - External tenant employer user
    patch:
      description: |
        __Activity name :__ PatchConfiguredExternalTenantByEmployerUserId

        __Metadata :__  N/A.

        __Defaults :__ N/A.

        Modify an external tenant to the list of an configured external tenants for an employer user.
        An configured external tenant may be removed by sending a request body with both an empty externalTenant object and an empty externalUser object.
      operationId: PatchConfiguredExternalTenantByEmployerUserId
      parameters:
        - description: The unique identifier of a employer user
          in: path
          name: employerUserId
          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 <TOKEN>
            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: false
              properties:
                externalTenant:
                  nullable: true
                  properties:
                    id:
                      description: The unique identifier (GUID/UUID) of an external tenant.  Input validation; the value of this field MUST match one of the external tenants that is available to this user (check the GetExternalTenants call)
                      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: The user-friendly name of the external tenant
                      example: Loket tenant
                      maxLength: 28
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                externalUser:
                  nullable: true
                  properties:
                    id:
                      description: The unique identifier of an Azure AD user. The id of an user can be found in in Azure AD application. Within this endpoint there is no input validation for this value, but in order to succesfully perform the Azure AD login flow it must correspond with an actual user id within the provided external tenant.
                      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: Add an external tenant for an employer user.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          externalTenant:
                            nullable: true
                            properties:
                              id:
                                description: The unique identifier (GUID/UUID) of an external tenant.  Input validation; the value of this field MUST match one of the external tenants that is available to this user (check the GetExternalTenants call)
                                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: The user-friendly name of the external tenant
                                example: Loket tenant
                                maxLength: 28
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          externalUser:
                            nullable: true
                            properties:
                              id:
                                description: The unique identifier of an Azure AD user. The id of an user can be found in in Azure AD application. Within this endpoint there is no input validation for this value, but in order to succesfully perform the Azure AD login flow it must correspond with an actual user id within the provided external tenant.
                                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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 an external tenant for an employer user
      tags:
        - External tenant employer user
  "/providers/employers/users/{userId}":
    delete:
      description: |
        __Activity name :__ DeleteEmployerUserByUserId

        Delete an existing user
      operationId: DeleteEmployerUserByUserId
      parameters:
        - description: The unique identifier of an user
          in: path
          name: userId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 user record
      tags:
        - Employer user
    get:
      description: |
        __Activity name :__ GetEmployerUserByUserId

        Get the details of an user
      operationId: GetEmployerUserByUserId
      parameters:
        - description: The unique identifier of an user
          in: path
          name: userId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          accessStatus:
                            description: indicates the access status of the user.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 3
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Has access to Client
                                maxLength: 255
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          azureActiveDirectory:
                            nullable: true
                            properties:
                              tenant:
                                description: The Azure AD tennant
                                format: metadata
                                properties:
                                  description:
                                    example: Customer X Azure AD
                                    maxLength: 100
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  id:
                                    description: Id for the tennant
                                    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
                                  tenantRegistrationLevel:
                                    enum:
                                      - provider
                                      - employer
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              userId:
                                description: The userId as known in the Azure AD of the selected tennant
                                example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                nullable: false
                                readOnly: false
                                type: string
                            type: object
                          contactInformation:
                            nullable: false
                            properties:
                              emailAddress:
                                description: The e-mail address of the user.
                                example: info@loket.nl
                                maxLength: 255
                                nullable: false
                                pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                readOnly: false
                                type: string
                              phoneNumber:
                                description: The phone number of the user.
                                example: +31 13-1234567
                                maxLength: 15
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              placeOfEmployment:
                                description: The place of employment (standplaats) for the user.
                                example: Amsterdam office
                                maxLength: 24
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                            type: object
                          dateTimeCreation:
                            description: The date on which the user was created
                            example: 2020-01-19
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          dateTimeLastLogin:
                            description: The date on which the user loged in for the last time
                            example: 2021-01-19
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          hasAccessToPayrollingTestData:
                            description: Indicates if the user has access to data for payrolling test years
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          hasIntegrations:
                            description: Indicates if the user has integrations with clients other that Loket
                            example: false
                            nullable: false
                            readOnly: true
                            type: boolean
                          hasMultiFactorAuthentication:
                            description: |-
                              Indicates if the user has multi factor authentication enabled

                              Can only be changed from true to false.
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          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
                          isDepartmentManager:
                            description: Indicates if the user is a department manager
                            example: false
                            nullable: false
                            readOnly: true
                            type: boolean
                          isLinkedToMultipleEmployers:
                            description: Indicates if the user has access to multiple employer.
                            example: false
                            nullable: false
                            readOnly: true
                            type: boolean
                          loginMethod:
                            description: The allowedlogin method for the user
                            format: metadata
                            properties:
                              key:
                                example: 3
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Only via SSO
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          personalDetails:
                            properties:
                              firstName:
                                description: The first name of the user
                                example: Susan
                                maxLength: 28
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              initials:
                                description: The initials of the user
                                example: S.L.
                                maxLength: 6
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Bergen
                                maxLength: 25
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: van
                                maxLength: 10
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                            type: object
                          twoFactorAuthenticationRequired:
                            description: "Indicates whether two factor authentication is required for the user. This setting is only available for login method: Via website en SSO "
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          userCustomSpecifiedRole:
                            description: |
                              Further specification of the user role.
                            example: Secretariaat medewerker
                            maxLength: 50
                            nullable: true
                            readOnly: false
                            type: string
                          userName:
                            description: The username
                            example: User42
                            maxLength: 50
                            minLength: 3
                            nullable: true
                            readOnly: true
                            type: string
                          userSpecifiedRole:
                            description: The Role which the user has specified.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 3
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Salarisadministrateur
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 user
      tags:
        - Employer user
    patch:
      description: |
        __Activity name :__ PatchEmployerUserInviteByUserId

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired via /providers/employers/{employerId}/users/metadata

        __Defaults :__ No defaults

        Resend or change the status of an invite for an employer user. 
      operationId: PatchEmployerUserInviteByUserId
      parameters:
        - description: The unique identifier of an user
          in: path
          name: userId
          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 <TOKEN>
            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: indicates the action to perform.
                  enum:
                    - Resend
                    - Revoke
                  nullable: false
                  readOnly: false
                  type: string
                destinationForSecret:
                  description: The destination phonenumber to sent the secret to during registration.
                  example: "0612345678"
                  maxLength: 15
                  minLength: 3
                  nullable: true
                  readOnly: false
                  type: string
              type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          accessStatus:
                            description: indicates the access status of the user.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 3
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Has access to Client
                                maxLength: 255
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          azureActiveDirectory:
                            nullable: true
                            properties:
                              tenant:
                                description: The Azure AD tennant
                                format: metadata
                                properties:
                                  description:
                                    example: Customer X Azure AD
                                    maxLength: 100
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  id:
                                    description: Id for the tennant
                                    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
                                  tenantRegistrationLevel:
                                    enum:
                                      - provider
                                      - employer
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              userId:
                                description: The userId as known in the Azure AD of the selected tennant
                                example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                nullable: false
                                readOnly: false
                                type: string
                            type: object
                          contactInformation:
                            nullable: false
                            properties:
                              emailAddress:
                                description: The e-mail address of the user.
                                example: info@loket.nl
                                maxLength: 255
                                nullable: false
                                pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                readOnly: false
                                type: string
                              phoneNumber:
                                description: The phone number of the user.
                                example: +31 13-1234567
                                maxLength: 15
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              placeOfEmployment:
                                description: The place of employment (standplaats) for the user.
                                example: Amsterdam office
                                maxLength: 24
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                            type: object
                          dateTimeCreation:
                            description: The date on which the user was created
                            example: 2020-01-19
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          dateTimeLastLogin:
                            description: The date on which the user loged in for the last time
                            example: 2021-01-19
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          hasAccessToPayrollingTestData:
                            description: Indicates if the user has access to data for payrolling test years
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          hasIntegrations:
                            description: Indicates if the user has integrations with clients other that Loket
                            example: false
                            nullable: false
                            readOnly: true
                            type: boolean
                          hasMultiFactorAuthentication:
                            description: |-
                              Indicates if the user has multi factor authentication enabled

                              Can only be changed from true to false.
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          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
                          isDepartmentManager:
                            description: Indicates if the user is a department manager
                            example: false
                            nullable: false
                            readOnly: true
                            type: boolean
                          isLinkedToMultipleEmployers:
                            description: Indicates if the user has access to multiple employer.
                            example: false
                            nullable: false
                            readOnly: true
                            type: boolean
                          loginMethod:
                            description: The allowedlogin method for the user
                            format: metadata
                            properties:
                              key:
                                example: 3
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Only via SSO
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          personalDetails:
                            properties:
                              firstName:
                                description: The first name of the user
                                example: Susan
                                maxLength: 28
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              initials:
                                description: The initials of the user
                                example: S.L.
                                maxLength: 6
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Bergen
                                maxLength: 25
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: van
                                maxLength: 10
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                            type: object
                          twoFactorAuthenticationRequired:
                            description: "Indicates whether two factor authentication is required for the user. This setting is only available for login method: Via website en SSO "
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          userCustomSpecifiedRole:
                            description: |
                              Further specification of the user role.
                            example: Secretariaat medewerker
                            maxLength: 50
                            nullable: true
                            readOnly: false
                            type: string
                          userName:
                            description: The username
                            example: User42
                            maxLength: 50
                            minLength: 3
                            nullable: true
                            readOnly: true
                            type: string
                          userSpecifiedRole:
                            description: The Role which the user has specified.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 3
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Salarisadministrateur
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Resend or change the status of an invite for an employer user.
      tags:
        - Employer user
    put:
      description: |
        __Activity name :__ PutEmployerUserByUserId

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.

        Edit the details of an user
      operationId: PutEmployerUserByUserId
      parameters:
        - description: The unique identifier of an user
          in: path
          name: userId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                accessStatus:
                  description: indicates the access status of the user.
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      example: 3
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    value:
                      example: Has access to Client
                      maxLength: 255
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                azureActiveDirectory:
                  nullable: true
                  properties:
                    tenant:
                      description: The Azure AD tennant
                      format: metadata
                      properties:
                        description:
                          example: Customer X Azure AD
                          maxLength: 100
                          nullable: false
                          readOnly: true
                          type: string
                        id:
                          description: Id for the tennant
                          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
                        tenantRegistrationLevel:
                          enum:
                            - provider
                            - employer
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                    userId:
                      description: The userId as known in the Azure AD of the selected tennant
                      example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      nullable: false
                      readOnly: false
                      type: string
                  type: object
                contactInformation:
                  nullable: false
                  properties:
                    emailAddress:
                      description: The e-mail address of the user.
                      example: info@loket.nl
                      maxLength: 255
                      nullable: false
                      pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                      readOnly: false
                      type: string
                    phoneNumber:
                      description: The phone number of the user.
                      example: +31 13-1234567
                      maxLength: 15
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                    placeOfEmployment:
                      description: The place of employment (standplaats) for the user.
                      example: Amsterdam office
                      maxLength: 24
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                  type: object
                dateTimeCreation:
                  description: The date on which the user was created
                  example: 2020-01-19
                  format: date-time
                  nullable: false
                  readOnly: true
                  type: string
                dateTimeLastLogin:
                  description: The date on which the user loged in for the last time
                  example: 2021-01-19
                  format: date-time
                  nullable: true
                  readOnly: true
                  type: string
                hasAccessToPayrollingTestData:
                  description: Indicates if the user has access to data for payrolling test years
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                hasIntegrations:
                  description: Indicates if the user has integrations with clients other that Loket
                  example: false
                  nullable: false
                  readOnly: true
                  type: boolean
                hasMultiFactorAuthentication:
                  description: |-
                    Indicates if the user has multi factor authentication enabled

                    Can only be changed from true to false.
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                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
                isDepartmentManager:
                  description: Indicates if the user is a department manager
                  example: false
                  nullable: false
                  readOnly: true
                  type: boolean
                isLinkedToMultipleEmployers:
                  description: Indicates if the user has access to multiple employer.
                  example: false
                  nullable: false
                  readOnly: true
                  type: boolean
                loginMethod:
                  description: The allowedlogin method for the user
                  format: metadata
                  properties:
                    key:
                      example: 3
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Only via SSO
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                personalDetails:
                  properties:
                    firstName:
                      description: The first name of the user
                      example: Susan
                      maxLength: 28
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                    initials:
                      description: The initials of the user
                      example: S.L.
                      maxLength: 6
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Bergen
                      maxLength: 25
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: van
                      maxLength: 10
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                  type: object
                twoFactorAuthenticationRequired:
                  description: "Indicates whether two factor authentication is required for the user. This setting is only available for login method: Via website en SSO "
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                userCustomSpecifiedRole:
                  description: |
                    Further specification of the user role.
                  example: Secretariaat medewerker
                  maxLength: 50
                  nullable: true
                  readOnly: false
                  type: string
                userName:
                  description: The username
                  example: User42
                  maxLength: 50
                  minLength: 3
                  nullable: true
                  readOnly: true
                  type: string
                userSpecifiedRole:
                  description: The Role which the user has specified.
                  format: metadata
                  nullable: true
                  properties:
                    key:
                      example: 3
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Salarisadministrateur
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
              type: object
        description: User to edit.
        required: true
      responses:
        "202":
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Accepted
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of an user
      tags:
        - Employer user
  "/providers/employers/users/{userId}/employers":
    get:
      description: |
        __Activity name :__ GetLinkedEmployersByUserId


         List of employers accessible by the user
      operationId: GetLinkedEmployersByUserId
      parameters:
        - description: The unique identifier of an user
          in: path
          name: userId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - properties:
                                address:
                                  allOf:
                                    - properties:
                                        city:
                                          description: City of the address
                                          example: Leiden
                                          maxLength: 24
                                          nullable: false
                                          readOnly: false
                                          type: string
                                        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
                                        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
                                companyName:
                                  description: Name of the company
                                  example: Voorbeeld B.V.
                                  maxLength: 70
                                  nullable: false
                                  readOnly: false
                                  type: string
                                contact:
                                  properties:
                                    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:
                                  properties:
                                    phoneNumber:
                                      description: The telephone number of the employer
                                      example: (088) 31 11150
                                      maxLength: 15
                                      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
                                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
                                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:
                                  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
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 linked to the user
      tags:
        - Linked employers
  "/providers/employers/users/{userId}/integrations":
    get:
      description: |
        __Activity name:__ GetEmployerUserIntegrationsByUserId
            

        List of all the integrations for the employer user
      operationId: GetEmployerUserIntegrationsByUserId
      parameters:
        - description: The unique identifier of an user
          in: path
          name: userId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        nullable: false
                        properties:
                          application:
                            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
                              isBlocked:
                                description: Indicates whether the application as a whole is blocked (for all users)
                                example: true
                                nullable: false
                                readOnly: true
                                type: boolean
                              logo:
                                description: An URI to the logo of the client
                                example: https://api.loket.nl/v2/application/{applicationId}/logo/{version}
                                nullable: true
                                readOnly: true
                                type: string
                              name:
                                example: ABC international
                                maxLength: 100
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          createdOn:
                            description: The time the integration was succesfully initiated
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          isBlocked:
                            description: Indicates whether the application user combination is blocked (for this single user)
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          lastLogin:
                            description: The time the integration was last active
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 all the integrations for the employer user
      tags:
        - User
  "/providers/employers/users/{userId}/integrations/{applicationId}":
    delete:
      description: |
        __Activity name:__ DeleteEmployerUserIntegrationByUserIdAndApplicationId

        Delete an integration
      operationId: DeleteEmployerUserIntegrationByUserIdAndApplicationId
      parameters:
        - description: The unique identifier of an user
          in: path
          name: userId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of an integration
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 integration
      tags:
        - User
    put:
      description: |
        __Activity name :__ PutEmployerUserIntegrationByUserIdAndApplicationId

        Change the integration
      operationId: PutEmployerUserIntegrationByIntegrationId
      parameters:
        - description: The unique identifier of an user
          in: path
          name: userId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of an integration
          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 <TOKEN>
            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: false
              properties:
                application:
                  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
                    isBlocked:
                      description: Indicates whether the application as a whole is blocked (for all users)
                      example: true
                      nullable: false
                      readOnly: true
                      type: boolean
                    logo:
                      description: An URI to the logo of the client
                      example: https://api.loket.nl/v2/application/{applicationId}/logo/{version}
                      nullable: true
                      readOnly: true
                      type: string
                    name:
                      example: ABC international
                      maxLength: 100
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                createdOn:
                  description: The time the integration was succesfully initiated
                  example: 2018-05-08T15:16:49+02:00
                  format: date-time
                  nullable: false
                  readOnly: true
                  type: string
                isBlocked:
                  description: Indicates whether the application user combination is blocked (for this single user)
                  example: true
                  nullable: false
                  readOnly: false
                  type: boolean
                lastLogin:
                  description: The time the integration was last active
                  example: 2018-05-08T15:16:49+02:00
                  format: date-time
                  nullable: true
                  readOnly: true
                  type: string
              type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          application:
                            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
                              isBlocked:
                                description: Indicates whether the application as a whole is blocked (for all users)
                                example: true
                                nullable: false
                                readOnly: true
                                type: boolean
                              logo:
                                description: An URI to the logo of the client
                                example: https://api.loket.nl/v2/application/{applicationId}/logo/{version}
                                nullable: true
                                readOnly: true
                                type: string
                              name:
                                example: ABC international
                                maxLength: 100
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          createdOn:
                            description: The time the integration was succesfully initiated
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          isBlocked:
                            description: Indicates whether the application user combination is blocked (for this single user)
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          lastLogin:
                            description: The time the integration was last active
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 an integration
      tags:
        - User
  "/providers/employers/users/{userId}/integrations/{applicationId}/logo":
    get:
      description: |-
        __Activity name :__ GetEmployerUserIntegrationLogoByUserIdAndApplicationId

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

        __Caching:__ This resource changes very infrequently and can be cached for a longer time.

        Get the logo of the application. In case no logo is know the service will return a 404.
      operationId: GetEmployerUserIntegrationLogoByUserIdAndApplicationId
      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 <TOKEN>
            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: userId
          required: true
          schema:
            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:
        - User
  "/providers/employers/users/{userId}/notificationsettings":
    get:
      description: |
        __Activity name :__ GetEmployerUserNotificationSettingsByUserId 


         List the configuration per notification for the user
      operationId: GetEmployerUserNotificationSettingsByUserId
      parameters:
        - description: The unique identifier of an user
          in: path
          name: userId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          items:
                            properties:
                              createNumberOfDaysBeforeEvent:
                                description: The number of days that the notification is created befor the event takes place.
                                example: 30
                                format: int32
                                maximum: 99
                                minimum: 0
                                nullable: false
                                readOnly: false
                                type: integer
                              isEnabled:
                                description: Enable or disable a notification for a user
                                nullable: false
                                readOnly: false
                                type: boolean
                              notificationType:
                                description: The notification set
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 3
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Start of employment
                                    maxLength: 70
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              receiveDepartmentSignalsOnly:
                                description: |-
                                  Only receive notification for your departments.
                                  Not relevant if the user is not a department manager.
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              sendMailWhenNotificationIsCreated:
                                description: send an email when on creation of the notification
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                          type: array
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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: The notification settings for the user
      tags:
        - Employer user notification settings
    patch:
      description: |
        __Activity name :__ PatchEmployerUserNotificationSettingsByUserId

        Manage the employer user notifications and `notificationSet`.

        __Note:__ Currently the `notificationSet` doesnt do anything in regard to which notifications are enabled or disabled.  It only functions as a guide to the GUI to visualize and save the notifications linked to the `notificationSet`

        Only the changes supplied are processed existing records not supplied in the request body will be left unchanged.  e.g. If three notifications are enabled for the user and a patch is performed with in the body one new notification with the `isEnabled` = true. The result will be that the user has 4 enabled notifications.
      operationId: PatchEmployerUserNotificationSettingsByUserId
      parameters:
        - description: The unique identifier of an user
          in: path
          name: userId
          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 <TOKEN>
            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:
                notificationSet:
                  format: metadata
                  properties:
                    description:
                      example: Salarisadministrateur
                      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
                  type: object
                  writeOnly: true
                notifications:
                  items:
                    properties:
                      createNumberOfDaysBeforeEvent:
                        description: The number of days that the notification is created befor the event takes place.
                        example: 30
                        format: int32
                        maximum: 99
                        minimum: 0
                        nullable: false
                        readOnly: false
                        type: integer
                      isEnabled:
                        description: Enable or disable a notification for a user
                        nullable: false
                        readOnly: false
                        type: boolean
                      notificationType:
                        description: The notification set
                        format: metadata
                        nullable: true
                        properties:
                          key:
                            example: 3
                            format: int32
                            nullable: false
                            readOnly: false
                            type: integer
                          value:
                            example: Start of employment
                            maxLength: 70
                            nullable: false
                            readOnly: true
                            type: string
                        type: object
                      receiveDepartmentSignalsOnly:
                        description: |-
                          Only receive notification for your departments.
                          Not relevant if the user is not a department manager.
                        example: false
                        nullable: false
                        readOnly: false
                        type: boolean
                      sendMailWhenNotificationIsCreated:
                        description: send an email when on creation of the notification
                        example: false
                        nullable: false
                        readOnly: false
                        type: boolean
                  type: array
              type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Manage the employer user notification settings
      tags:
        - Employer user notification settings
  "/providers/employers/workflows/{workflowId}":
    get:
      description: |
        __Activity name:__ GetWorkflowByWorkflowId

        Get the details of a workflow 
      operationId: GetWorkflowByWorkflowId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: workflowId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          allowedTransitions:
                            description: |-
                              In this object the posible transitions are returned.
                              By sending a request to the `href` with the given `httpVerb` and one of the options given in `transitions` in the body. The workflow is transitioned to the given state.
                            items:
                              properties:
                                description:
                                  description: The description of the transition (task)
                                  example: Controleer de vergoedingen
                                  maxLength: 256
                                  nullable: true
                                  readOnly: true
                                  type: string
                                href:
                                  example: https://api.loket.nl/v2/providers/employers/workflows/{workflowId}/transition
                                  nullable: false
                                  readOnly: true
                                  type: string
                                httpVerb:
                                  enum:
                                    - POST
                                    - PATCH
                                    - PUT
                                  format: enum
                                  nullable: false
                                  readOnly: true
                                  type: string
                                transitions:
                                  example:
                                    - action: fabf3b25-abf9-4e8c-a8f7-81400d1b0e96
                                      description: Approve
                                    - action: abc31d45-f593-4d73-8078-6caba9cebdcc
                                      description: Reject
                                  items:
                                    properties:
                                      action:
                                        description: The unique identifier for the action to be taken
                                        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
                                      description:
                                        description: Description of the action
                                        example: Approve
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                  nullable: false
                                  readOnly: true
                                  type: array
                              type: object
                            nullable: true
                            readOnly: true
                            type: array
                          assignee:
                            description: A workflow is either assigned to a user or a role. A role can be filled by multiple users.
                            nullable: true
                            properties:
                              role:
                                format: metadata
                                nullable: true
                                properties:
                                  description:
                                    description: A description of the role.
                                    example: Employer
                                    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
                                type: object
                              user:
                                format: metadata
                                nullable: true
                                properties:
                                  formattedName:
                                    description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                    example: Jong, I
                                    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
                                  initials:
                                    description: The initials of the user
                                    example: I
                                    maxLength: 6
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  lastName:
                                    description: The last name of the user
                                    example: Jong
                                    maxLength: 25
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  prefix:
                                    description: The prefix of the user
                                    example: de
                                    maxLength: 10
                                    nullable: true
                                    readOnly: true
                                    type: string
                                type: object
                            type: object
                          data:
                            description: A JSON representation of the mutation/data regarding this workflow
                            example:
                              address:
                                city: Leiden
                                country:
                                  key: 1
                                houseNumber: 12
                                houseNumberAddition: D
                                postalCode: 1234 AA
                                street: Voordijk
                            format: JSON
                            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
                          initiatedBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          initiatedOn:
                            example: 2019-11-23T11:14:06Z
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          lastModifiedBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          lastModifiedOn:
                            description: date and time on which the last modification on the workflow was performed. This can be either by the system or a user.
                            example: 2019-11-23T11:14:06Z
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          status:
                            description: Indicates the status of the workflow as a whole.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: The unique identifier
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: In progress
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          trigger:
                            description: |-
                              Indicates the trigger that started the workflow.

                              `trigger` is a metadata field within the employer context. Possible values can be managed by the user. 
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Address change for employee
                                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
                            readOnly: true
                            type: object
                          workflowTemplate:
                            description: |-
                              Indicates what workflow template was used to initiate the workflow.

                              `workflowTemplate` is a metadata field within the employer context. Possible values can be managed by the user. 
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Approval by employer
                                maxLength: 256
                                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
                              version:
                                description: The version of the workflow template this workflow was based on. Changes to a workflow template do not affect existing workflows.
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                            readOnly: true
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 workflow
      tags:
        - Workflows
    put:
      description: |
        __Activity name:__ PutWorkflowByWorkflowId
          

        Allows the user to change certain asspects of the workflow

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.
      operationId: PutWorkflowByWorkflowId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            pattern: ^Bearer\s[\w-]+$
            type: string
        - description: The unique identifier of the record
          in: path
          name: workflowId
          required: true
          schema:
            format: uuid
            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:
                allowedTransitions:
                  description: |-
                    In this object the posible transitions are returned.
                    By sending a request to the `href` with the given `httpVerb` and one of the options given in `transitions` in the body. The workflow is transitioned to the given state.
                  items:
                    properties:
                      description:
                        description: The description of the transition (task)
                        example: Controleer de vergoedingen
                        maxLength: 256
                        nullable: true
                        readOnly: true
                        type: string
                      href:
                        example: https://api.loket.nl/v2/providers/employers/workflows/{workflowId}/transition
                        nullable: false
                        readOnly: true
                        type: string
                      httpVerb:
                        enum:
                          - POST
                          - PATCH
                          - PUT
                        format: enum
                        nullable: false
                        readOnly: true
                        type: string
                      transitions:
                        example:
                          - action: fabf3b25-abf9-4e8c-a8f7-81400d1b0e96
                            description: Approve
                          - action: abc31d45-f593-4d73-8078-6caba9cebdcc
                            description: Reject
                        items:
                          properties:
                            action:
                              description: The unique identifier for the action to be taken
                              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
                            description:
                              description: Description of the action
                              example: Approve
                              nullable: false
                              readOnly: true
                              type: string
                          type: object
                        nullable: false
                        readOnly: true
                        type: array
                    type: object
                  nullable: true
                  readOnly: true
                  type: array
                assignee:
                  description: A workflow is either assigned to a user or a role. A role can be filled by multiple users.
                  nullable: true
                  properties:
                    role:
                      format: metadata
                      nullable: true
                      properties:
                        description:
                          description: A description of the role.
                          example: Employer
                          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
                      type: object
                    user:
                      format: metadata
                      nullable: true
                      properties:
                        formattedName:
                          description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                          example: Jong, I
                          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
                        initials:
                          description: The initials of the user
                          example: I
                          maxLength: 6
                          nullable: false
                          readOnly: true
                          type: string
                        lastName:
                          description: The last name of the user
                          example: Jong
                          maxLength: 25
                          nullable: false
                          readOnly: true
                          type: string
                        prefix:
                          description: The prefix of the user
                          example: de
                          maxLength: 10
                          nullable: true
                          readOnly: true
                          type: string
                      type: object
                  type: object
                data:
                  description: A JSON representation of the mutation/data regarding this workflow
                  example:
                    address:
                      city: Leiden
                      country:
                        key: 1
                      houseNumber: 12
                      houseNumberAddition: D
                      postalCode: 1234 AA
                      street: Voordijk
                  format: JSON
                  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
                initiatedBy:
                  format: metadata
                  nullable: false
                  properties:
                    formattedName:
                      description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                initiatedOn:
                  example: 2019-11-23T11:14:06Z
                  format: date-time
                  nullable: false
                  readOnly: true
                  type: string
                lastModifiedBy:
                  format: metadata
                  nullable: false
                  properties:
                    formattedName:
                      description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                lastModifiedOn:
                  description: date and time on which the last modification on the workflow was performed. This can be either by the system or a user.
                  example: 2019-11-23T11:14:06Z
                  format: date-time
                  nullable: false
                  readOnly: true
                  type: string
                status:
                  description: Indicates the status of the workflow as a whole.
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      description: The unique identifier
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: In progress
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
                trigger:
                  description: |-
                    Indicates the trigger that started the workflow.

                    `trigger` is a metadata field within the employer context. Possible values can be managed by the user. 
                  format: metadata
                  nullable: false
                  properties:
                    description:
                      example: Address change for employee
                      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
                  readOnly: true
                  type: object
                workflowTemplate:
                  description: |-
                    Indicates what workflow template was used to initiate the workflow.

                    `workflowTemplate` is a metadata field within the employer context. Possible values can be managed by the user. 
                  format: metadata
                  nullable: false
                  properties:
                    description:
                      example: Approval by employer
                      maxLength: 256
                      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
                    version:
                      description: The version of the workflow template this workflow was based on. Changes to a workflow template do not affect existing workflows.
                      example: 2
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                  readOnly: true
                  type: object
              type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          allowedTransitions:
                            description: |-
                              In this object the posible transitions are returned.
                              By sending a request to the `href` with the given `httpVerb` and one of the options given in `transitions` in the body. The workflow is transitioned to the given state.
                            items:
                              properties:
                                description:
                                  description: The description of the transition (task)
                                  example: Controleer de vergoedingen
                                  maxLength: 256
                                  nullable: true
                                  readOnly: true
                                  type: string
                                href:
                                  example: https://api.loket.nl/v2/providers/employers/workflows/{workflowId}/transition
                                  nullable: false
                                  readOnly: true
                                  type: string
                                httpVerb:
                                  enum:
                                    - POST
                                    - PATCH
                                    - PUT
                                  format: enum
                                  nullable: false
                                  readOnly: true
                                  type: string
                                transitions:
                                  example:
                                    - action: fabf3b25-abf9-4e8c-a8f7-81400d1b0e96
                                      description: Approve
                                    - action: abc31d45-f593-4d73-8078-6caba9cebdcc
                                      description: Reject
                                  items:
                                    properties:
                                      action:
                                        description: The unique identifier for the action to be taken
                                        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
                                      description:
                                        description: Description of the action
                                        example: Approve
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                  nullable: false
                                  readOnly: true
                                  type: array
                              type: object
                            nullable: true
                            readOnly: true
                            type: array
                          assignee:
                            description: A workflow is either assigned to a user or a role. A role can be filled by multiple users.
                            nullable: true
                            properties:
                              role:
                                format: metadata
                                nullable: true
                                properties:
                                  description:
                                    description: A description of the role.
                                    example: Employer
                                    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
                                type: object
                              user:
                                format: metadata
                                nullable: true
                                properties:
                                  formattedName:
                                    description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                    example: Jong, I
                                    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
                                  initials:
                                    description: The initials of the user
                                    example: I
                                    maxLength: 6
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  lastName:
                                    description: The last name of the user
                                    example: Jong
                                    maxLength: 25
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  prefix:
                                    description: The prefix of the user
                                    example: de
                                    maxLength: 10
                                    nullable: true
                                    readOnly: true
                                    type: string
                                type: object
                            type: object
                          data:
                            description: A JSON representation of the mutation/data regarding this workflow
                            example:
                              address:
                                city: Leiden
                                country:
                                  key: 1
                                houseNumber: 12
                                houseNumberAddition: D
                                postalCode: 1234 AA
                                street: Voordijk
                            format: JSON
                            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
                          initiatedBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          initiatedOn:
                            example: 2019-11-23T11:14:06Z
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          lastModifiedBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          lastModifiedOn:
                            description: date and time on which the last modification on the workflow was performed. This can be either by the system or a user.
                            example: 2019-11-23T11:14:06Z
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          status:
                            description: Indicates the status of the workflow as a whole.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: The unique identifier
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: In progress
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          trigger:
                            description: |-
                              Indicates the trigger that started the workflow.

                              `trigger` is a metadata field within the employer context. Possible values can be managed by the user. 
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Address change for employee
                                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
                            readOnly: true
                            type: object
                          workflowTemplate:
                            description: |-
                              Indicates what workflow template was used to initiate the workflow.

                              `workflowTemplate` is a metadata field within the employer context. Possible values can be managed by the user. 
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Approval by employer
                                maxLength: 256
                                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
                              version:
                                description: The version of the workflow template this workflow was based on. Changes to a workflow template do not affect existing workflows.
                                example: 2
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                            readOnly: true
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the workflow
      tags:
        - Workflows
  "/providers/employers/workflows/{workflowId}/transition":
    post:
      description: |-
        __Activity name:__ TransitionWorkflowByWorkflowId
          

        Allows the user to transition the workflow to a different state. 
        Use the workflows endpoint and then the `allowedTransitions` element to determine what to submit to this endpoint.
      operationId: TransitionWorkflowByWorkflowId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: workflowId
          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 <TOKEN>
            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:
            examples:
              approve:
                value:
                  action: fabf3b25-abf9-4e8c-a8f7-81400d1b0e96
                  description: Approve
              reject:
                value:
                  action: abc31d45-f593-4d73-8078-6caba9cebdcc
                  description: Reject
            schema:
              description: |-
                Because this object is dynamic accorinding to what transition and which workflow we give a few examples here.

                To ensure correct functionality __always__ POST the full object retrived from the `transitions` array in the workflow(s) endpoint.  By always POSTing the full object we are able to change the object without these changes influencing the integration. Allowing us to add additional functionality without breaking the contract/
              nullable: true
              properties: {}
              type: object
        required: true
      responses:
        "202":
          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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Accepted
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Allows the user to transition the workflow.
      tags:
        - Workflows
  "/providers/employers/workflowtriggermappings/{workflowTriggerMappingId}":
    delete:
      description: |
        __Activity name:__ DeleteWorkflowTriggerMappingByWorkflowTriggerMappingId

        Delete a workflow trigger mapping record for the employer
      operationId: DeleteFiscalPropertiesByworkflowTriggerId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: workflowTriggerMappingId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 workflow trigger mapping record
      tags:
        - Workflow trigger mapping
    get:
      description: |
        __Activity name:__ GetWorkflowTriggerMappingByWorkflowTriggerMappingId

        Get the details of a workflow trigger mapping
      operationId: GetWorkflowTriggerMappingByWorkflowTriggerMappingId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: workflowTriggerMappingId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          createdBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          createdOn:
                            example: 2019-11-23T11:14:06Z
                            format: date-time
                            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
                          lastModifiedBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          lastModifiedOn:
                            example: 2019-11-23T11:14:06Z
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          trigger:
                            description: |-
                              Indicates the workflow trigger to be configured.

                              `trigger` is a metadata field within the employer context. Possible values can be managed by the user. 
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Address change for employee
                                maxLength: 256
                                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
                            type: object
                          workflowTemplate:
                            description: |-
                              Indicates what workflow template will be used to initiate a workflow when the trigger takes place.

                              `workflowTemplate` is a metadata field within the employer context. Possible values can be managed by the user. 
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Approval by employer
                                maxLength: 256
                                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
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 workflow trigger mapping record
      tags:
        - Workflow trigger mapping
    put:
      description: |
        __Activity name:__ PutWorkflowTriggerMappingByWorkflowTriggerMappingId

        Edit the details for a workflow trigger mapping record

        Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.
      operationId: PutWorkflowTriggerByWorkflowTriggerId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: workflowTriggerMappingId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              nullable: true
              properties:
                createdBy:
                  format: metadata
                  nullable: false
                  properties:
                    formattedName:
                      description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                createdOn:
                  example: 2019-11-23T11:14:06Z
                  format: date-time
                  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
                lastModifiedBy:
                  format: metadata
                  nullable: false
                  properties:
                    formattedName:
                      description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                lastModifiedOn:
                  example: 2019-11-23T11:14:06Z
                  format: date-time
                  nullable: false
                  readOnly: true
                  type: string
                trigger:
                  description: |-
                    Indicates the workflow trigger to be configured.

                    `trigger` is a metadata field within the employer context. Possible values can be managed by the user. 
                  format: metadata
                  nullable: false
                  properties:
                    description:
                      example: Address change for employee
                      maxLength: 256
                      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
                  type: object
                workflowTemplate:
                  description: |-
                    Indicates what workflow template will be used to initiate a workflow when the trigger takes place.

                    `workflowTemplate` is a metadata field within the employer context. Possible values can be managed by the user. 
                  format: metadata
                  nullable: false
                  properties:
                    description:
                      example: Approval by employer
                      maxLength: 256
                      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
                  type: object
              type: object
        description: Workflow trigger 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          createdBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          createdOn:
                            example: 2019-11-23T11:14:06Z
                            format: date-time
                            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
                          lastModifiedBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          lastModifiedOn:
                            example: 2019-11-23T11:14:06Z
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          trigger:
                            description: |-
                              Indicates the workflow trigger to be configured.

                              `trigger` is a metadata field within the employer context. Possible values can be managed by the user. 
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Address change for employee
                                maxLength: 256
                                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
                            type: object
                          workflowTemplate:
                            description: |-
                              Indicates what workflow template will be used to initiate a workflow when the trigger takes place.

                              `workflowTemplate` is a metadata field within the employer context. Possible values can be managed by the user. 
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Approval by employer
                                maxLength: 256
                                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
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a workflow trigger mapping record
      tags:
        - Workflow trigger mapping
  "/providers/employers/{employerId}":
    get:
      description: |
        __Activity name :__ GetEmployerByEmployerId

        Get the details of a single employers
      operationId: GetEmployerByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        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: 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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employer
      tags:
        - Employer
    put:
      description: |
        __Activity name:__ PutEmployerByEmployerId

        Edit the details of an employer

        Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.
      operationId: PutEmployerByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              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
        description: Employer
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of an employer
      tags:
        - Employer
  "/providers/employers/{employerId}/actualorganizationalentities":
    get:
      description: |
        __Activity name:__ GetActualOrganizationalEntitiesByEmployerId
            

        Get the list of actual organizational entities for an employer
      operationId: GetActualOrganizationalEntitiesByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: Set a reference date for choosing the date dependent data.
          in: query
          name: referenceDate
          required: false
          schema:
            example: 2022-01-01
            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:
                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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - properties:
                                employmentId:
                                  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
                                organizationalEntity:
                                  properties:
                                    department:
                                      description: |-
                                        The department of the employment.

                                        `department` is a metadata field within the employer context. Possible values can be managed by the user.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        code:
                                          example: 2
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        description:
                                          example: Verkoop
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        key:
                                          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
                                      type: object
                                    deviatingFunctionDescription:
                                      description: The deviating function description of the employment. This description deviates from the value of the `function` field.
                                      example: Directeur
                                      maxLength: 50
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    deviatingFunctionGroup:
                                      description: The deviating function group description of the employment. Only applies when a deviating function description is defined.
                                      example: 9A
                                      maxLength: 5
                                      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.

                                        `distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        code:
                                          example: 2
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        description:
                                          example: Sales
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        key:
                                          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
                                      type: object
                                    endDate:
                                      description: The end date of the entity. The date is up to and including.
                                      example: 2018-10-23
                                      format: date
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    function:
                                      description: |-
                                        The function of the employment.

                                        `function` is a metadata field within the employer context. Possible values can be managed by the user.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        description:
                                          example: Directeur
                                          maxLength: 50
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        group:
                                          example: internal
                                          maxLength: 5
                                          nullable: true
                                          readOnly: true
                                          type: string
                                        key:
                                          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
                                      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
                                    internalTelephoneExtensionNumber:
                                      description: The phone number of the standard working location (standplaats) for the employment.
                                      example: "678"
                                      maxLength: 15
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    placeOfEmployment:
                                      description: The standard working location (standplaats) for the employment.
                                      example: Amsterdam office
                                      maxLength: 24
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    standardFunction:
                                      description: |-
                                        The standard (cao)function of the employment.

                                        `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
                                    startDate:
                                      description: |-
                                        The start date of the entity.

                                        A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                                      example: 2018-01-01
                                      format: date
                                      nullable: false
                                      readOnly: false
                                      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: 2018-12-31
                            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 <field>
                              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.
                                See [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 actual organizational entities for an employer
      tags:
        - Actuals
  "/providers/employers/{employerId}/actualwages":
    get:
      description: |
        __Activity name:__ GetActualWagesByEmployerId
            

        Get the list of actual wages for an employer
      operationId: GetActualWagesByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: Set a reference date for choosing the date dependent data.
          in: query
          name: referenceDate
          required: false
          schema:
            example: 2022-01-01
            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:
                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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - properties:
                                employmentId:
                                  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
                                wage:
                                  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.
                                      example: true
                                      nullable: true
                                      readOnly: false
                                      type: boolean
                                    employerCosts:
                                      description: |
                                        The cost for the employer for this employee.
                                      example: 3500
                                      format: double
                                      maximum: 99999.99
                                      minimum: 0.01
                                      nullable: true
                                      readOnly: false
                                      type: number
                                    employerCostsType:
                                      description: |
                                        Indicates whether the employer costs are hourly costs or periodic costs. 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.
                                      format: metadata
                                      nullable: true
                                      properties:
                                        key:
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                        value:
                                          example: hourly
                                          maxLength: 50
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      type: object
                                    endDate:
                                      description: |
                                        The end date for the information in the record.
                                      format: date
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    grossWage:
                                      description: |
                                        The gross wage for the employee
                                      example: 2300
                                      format: double
                                      maximum: 999999.99
                                      minimum: 0.01
                                      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.
                                      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
                                    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
                                    isGrossWageFullTime:
                                      description: |
                                        Indicates whether the given grossWage is either a full-time wage or a part-time wage. Full-time wage is the default value (isGrossWageFulltime = true) and Loket.nl recommends to use this option. A full-time wage takes into account the part-time percentage of an employment. While a part-time wage does not. E.g. A full-time wage of 2400 euro’s is registered. The employments works 20 out of 40 hours (40 fours is a full-time shift) thus having a 20/40 = 50% part-time percentage. The part-time hours (deviatingHoursPerWeek) are accessible through the endpoint for working hours of an employement. In the wage calculation Loket.nl will divide the grossWage component by 50% resulting in a grossWage of 1200 euro’s. In the case of a part-time wage the part-time percentage will be ignored.
                                      example: true
                                      nullable: false
                                      readOnly: true
                                      type: boolean
                                    netWage:
                                      description: |
                                        Net wage for the employment
                                      example: 2400
                                      format: double
                                      maximum: 999999.99
                                      minimum: 0.01
                                      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.
                                      format: metadata
                                      nullable: true
                                      properties:
                                        key:
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          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. 

                                        `payGrade` is a metadata field within the payroll administration/payScale 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: 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.

                                        `payScale` 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: Glastuinbouw maand, Loongebouw A
                                          maxLength: 50
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      type: object
                                    payrollPeriodType:
                                      description: |
                                        Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4). The value of this field is used to further specify the meaning of grossWageType, netWageType and employerCostsType. When the key fields of these three wage types have a value 1 (meaning periodic wage), the payrollPeriodType field shows the period type (month, 4 weeks or week) applicable to the wages for the employment. E.g. If the value for grossWageType.key = 1 (periodic wage) and the value for payrollPeriodType.key = 1 (meaning Month), then the wage registerd in grossWage is a monthly wage. Note that in cases where the wage type is an hourly wage (grossWageType.key = 2), the payrollPeriodType should be ignored.
                                      nullable: false
                                      properties:
                                        key:
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        value:
                                          example: Maand
                                          maxLength: 50
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    startDate:
                                      description: |
                                        The start date for the information in the record.

                                        A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                                        __Note__ It is posible to have no wage record.
                                      example: 1995-05-21
                                      format: date
                                      nullable: false
                                      readOnly: false
                                      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: 2018-12-31
                            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 <field>
                              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.
                                See [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 actual wages for an employer
      tags:
        - Actuals
  "/providers/employers/{employerId}/actualworkinghours":
    get:
      description: |
        __Activity name:__ GetActualWorkingHoursByEmployerId
            

        Get the list of actual working hours for an employer
      operationId: GetActualWorkingHoursByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: Set a reference date for choosing the date dependent data.
          in: query
          name: referenceDate
          required: false
          schema:
            example: 2022-01-01
            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:
                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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - properties:
                                employmentId:
                                  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
                                workingHours:
                                  properties:
                                    aggregatedHoursPerWeek:
                                      description: |-
                                        This read-only field provides the user with a single point of knowledge as to what number of hours per week employment is actually registered in regards to the payrolling process. This number may be respectively based on the workpattern, deviating hours per week or shift hours. If the employment is an 'on call employment' (oproepkracht/invalkracht) the number is either NULL or represents the min-hours if that is applicable.
                                        This field is especially useful for third-parties that want to know the number of hours per week (without having to apply specific Loket logic). I.e. this field is not visible in Loket GUI.
                                      example: 24
                                      format: double
                                      maximum: 168
                                      minimum: 0.01
                                      nullable: true
                                      pattern: ^(\d{1,2})(\.\d{1,2})?$
                                      readOnly: true
                                      type: number
                                    averageHoursPerWeek:
                                      description: This field can be used to register the average hours per week an employment with varying hours works. For example, 0 hour contracts and min max contracts. The value of this field does NOT directly affect the payrolling proces.
                                      example: 32
                                      format: double
                                      maximum: 168
                                      minimum: 0
                                      nullable: true
                                      pattern: ^(\d{1,3})(\.\d{1,2})?$
                                      readOnly: false
                                      type: number
                                    averageParttimeFactor:
                                      description: |-
                                        This field is used to register the deviating value of the parttimefactor, purely for administrative purposes. The parttimefactor is normally calculated by workinghours dividing by shifthours multplied by 100. 
                                        Please note that this field is not used in the actual payroll proces! For the payroll process the number of hours is used.
                                      format: double
                                      maximum: 999.99
                                      minimum: 0.01
                                      nullable: true
                                      pattern: ^(\d{1,3})(\.\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). Onderliggende elementen geven aan of specifieke waardes berekend moeten worden op basis van het twee wekelijks werkpatroon `workPattern`
                                      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: false
                                          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: false
                                          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: false
                                          readOnly: false
                                          type: boolean
                                        hoursRegularPeriod:
                                          description: Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods.
                                          example: false
                                          nullable: false
                                          readOnly: false
                                          type: boolean
                                        leaveHours:
                                          description: |
                                            Indicates whether then leave balances (verlof) are to be calculated based on the workpattern.  If set to false and the user is not linked to a leave policy with `applyLeaveSchedule` set to true the following fields are used for the calculation `deviatingHoursPerWeek` if null `shift.fullTimeHoursPerWeek` is used
                                          example: true
                                          nullable: false
                                          readOnly: false
                                          type: boolean
                                      type: object
                                    contractCode:
                                      description: |-
                                        This field is specialy made for convenience stores. The field is the type of contract.

                                        `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)
                                          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: If this field is empty the fulltime hours are based as defined by the shift, this optional field is used to register an overwriting value. The value can be less or more then the fulltime hours a week.
                                      example: 32
                                      format: double
                                      maximum: 99.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: 20
                                      format: int32
                                      maximum: 23
                                      minimum: 1
                                      nullable: true
                                      readOnly: false
                                      type: integer
                                    endDate:
                                      description: |
                                        The end date of the entity. The date is up to and including.
                                      example: 2018-10-23
                                      format: date
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    flexibleHoursContract:
                                      description: The field indicates the type of flexible contract. If not applicable, please set to NULL.
                                      format: metadata
                                      nullable: true
                                      properties:
                                        key:
                                          example: 2
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                        value:
                                          example: Minimum uren contract
                                          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
                                    regularWorkPattern:
                                      description: When the employee works the same amount of hours per day every week, then the workpattern is regular.
                                      example: true
                                      nullable: false
                                      readOnly: false
                                      type: boolean
                                    shift:
                                      description: |
                                        The shift determines the full-time hours and bonus percentage.

                                        `shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                      format: metaData
                                      nullable: false
                                      properties:
                                        bonusPercentage:
                                          description: |
                                            The bonus percentage used in wage calculations for the hours made in this shift.
                                          example: 12
                                          maximum: 99
                                          minimum: 0.01
                                          nullable: false
                                          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
                                          nullable: false
                                          readOnly: true
                                          type: number
                                        shiftNumber:
                                          description: |
                                            The number for the shift.
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                      type: object
                                    shiftRateSickLeave:
                                      description: |
                                        The shift determines the full-time hours and bonus percentage.

                                        `shiftRateSickLeave` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                      format: metadata
                                      properties:
                                        bonusPercentage:
                                          description: |
                                            The bonus percentage used in wage calculations for the hours made in this shift.
                                          example: 12
                                          maximum: 99
                                          minimum: 1
                                          nullable: false
                                          readOnly: true
                                          type: number
                                        fullTimeHoursPerWeek:
                                          description: |
                                            The full time hours for an employment that is linked to this shift.
                                          example: 40
                                          maximum: 99
                                          minimum: 1
                                          nullable: false
                                          readOnly: true
                                          type: number
                                        shiftNumber:
                                          description: |
                                            The key number to identify the shift to be used for calculation of daily rate in case of sick leave (ziekte).
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                      type: object
                                    startDate:
                                      description: |
                                        Start date of the record.

                                        A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                                      example: 2018-01-01
                                      format: date
                                      nullable: false
                                      readOnly: false
                                      type: string
                                    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. <br /> Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                                      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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 actual working hours for an employer
      tags:
        - Actuals
  "/providers/employers/{employerId}/administrations":
    get:
      description: |
        __Activity name :__ GetAdministrationsByEmployerId

        Get a list of all administrations (both payroll and non-payroll) for an employer. This endpoint only returns properties that are shared between payroll and non-payroll administrations. For more detailed properties, use the respective endpoints for payroll and non-payroll administrations.
      operationId: GetAdministrationsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          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: false
                              type: string
                            endDate:
                              description: |
                                The last day the administration is active.
                              example: 2020-12-31
                              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
                            isPayrollAdministration:
                              description: |
                                Indicates whether the administration is a payroll administration
                              example: true
                              nullable: false
                              readOnly: true
                              type: boolean
                            startDate:
                              description: |
                                The first day the administration is active.
                              example: 2016-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 administrations for an employer
      tags:
        - Administration
  "/providers/employers/{employerId}/announcements":
    get:
      description: |
        __Activity name :__ GetAnnouncementsByEmployerId

        Get a list of announcements for an employer. The list contains a isRead parameter.
      operationId: GetAnnouncementsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            creationDate:
                              description: The date on which the announcement was announced.
                              example: 2018-02-05
                              format: date
                              nullable: false
                              readOnly: true
                              type: string
                            description:
                              description: description of the announcement
                              example: Schaal X krijgt een verhoging van Y procent.
                              maxLength: 7500
                              nullable: false
                              readOnly: true
                              type: string
                            effectiveDate:
                              description: The date on which the announcement takes effect
                              example: 2018-02-05
                              format: date
                              nullable: false
                              readOnly: true
                              type: string
                            expirationDate:
                              description: The date on which the announcement expires
                              example: 2018-02-05
                              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
                            isExpired:
                              description: Indicates whether the announcement has expired.
                              example: false
                              nullable: false
                              readOnly: true
                              type: boolean
                            isRead:
                              description: Indicates whether the announcement has been read
                              example: false
                              nullable: false
                              readOnly: false
                              type: boolean
                            subject:
                              description: subject of the announcement
                              example: Schaalverhoging
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 announcements for an employer.
      tags:
        - Announcement
  "/providers/employers/{employerId}/applications":
    get:
      description: |
        __Activity name:__ GetAvailableApplicationsByEmployerId
            

        List of all the applications available to the employer.
      operationId: GetAvailableApplicationsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            activationUrl:
                              description: An URI to a webpage of the application where the user can initiate the integration.
                              example: https://application.nl
                              nullable: true
                              readOnly: true
                              type: string
                            applicationTypes:
                              description: The type of software e.g. planning or finiance.
                              items:
                                properties:
                                  key:
                                    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
                                  value:
                                    description: "Example values: - arbeidsvoorwaarden - data-analyse  - document management - financieel - integratie - pensioenuitvoerder - planning - portal - proces - rapportage - tijdregistratie - verzuim/verzekering"
                                    example: planning
                                    nullable: false
                                    readOnly: true
                                type: object
                              type: array
                            dateAddedToStore:
                              description: The date to which the application was added to the store
                              example: 2021-12-31
                              format: date
                              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
                            isActivatedForEmployer:
                              description: |-
                                Indicates whether the application is configured for the given employer.
                                If one (or more) users with access to the employer have a connection with the application (the isBlocked boolean from both application and application user are ignored for this field)
                              example: true
                              nullable: false
                              readOnly: true
                              type: boolean
                            isHighlighted:
                              description: Indicates whether the application is highlighted (shown at the top of the list by default)
                              example: true
                              nullable: false
                              readOnly: true
                              type: boolean
                            logo:
                              description: An URI to the logo of the application
                              example: https://api.loket.nl/v2/applications/{applicationId}/logo/{version}
                              nullable: true
                              readOnly: true
                              type: string
                            marketplaceDescription:
                              description: A description of the application. The description must be in HTML.
                              example: ABC international is the worlds leading etc.
                              nullable: true
                              readOnly: true
                              type: string
                            marketplaceSummary:
                              description: A short summary of the application. The description must be in plain text.
                              example: World-leading application for excellent employers
                              maxLength: 200
                              nullable: true
                              readOnly: true
                              type: string
                            name:
                              example: ABC international
                              maxLength: 100
                              nullable: false
                              readOnly: true
                              type: string
                            targetIndustries:
                              description: The industries for which the software is primarily used
                              items:
                                properties:
                                  key:
                                    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
                                  value:
                                    description: "-  accountancy & administratie -  agrosector -  bouw, installatie & infrastructuur -  cultuur & sport -  energie -  financiële dienstverlening -  gezondheidszorg & maatschappelijke dienstverlening -  groothandel -  horeca -  ICT, media & communicatie -  industrie -  kinderopvang -  onderwijs & training -  onroerend goed -  persoonlijke dienstverlening & non-profit -  retail -  vervoer, post & opslag -  water & afval -  zakelijke dienstverlening       "
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              type: array
                            website:
                              description: An URI to the website of the application
                              example: https://application.nl
                              nullable: true
                              readOnly: true
                              type: string
                          readOnly: true
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 all the applications available to the employer
      tags:
        - Application
  "/providers/employers/{employerId}/applications/{applicationId}/users":
    get:
      description: |
        __Activity name:__ GetLinkedUsersByEmployerIdAndApplicationId
            

        List of all users that are configred to have both access to the employer and have an connection with the application.
      operationId: GetLinkedUsersByEmployerIdAndApplicationId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          required: true
          schema:
            format: uuid
            type: string
        - 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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            createdOn:
                              description: The time the integration was succesfully initiated
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            isblocked:
                              description: Indicates whether this specific user application link is blocked
                              example: true
                              nullable: false
                              readOnly: false
                              type: boolean
                            lastLogin:
                              description: The last time the integration was active
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            user:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 all the users linking the applications and the employer
      tags:
        - Application
  "/providers/employers/{employerId}/assessments":
    get:
      description: |
        __Activity name :__ GetAssessmentsByEmployerId


        Retrieve a list of assessments.
      operationId: GetAssessmentsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            invitedDate:
                              description: The date on which the invite for the Assessment was send
                              example: 2022-02-22
                              format: date
                              nullable: true
                              readOnly: true
                              type: string
                            participant:
                              description: Information about the participant.
                              nullable: false
                              properties:
                                email:
                                  description: The email adresses of the initiator
                                  example: test@test.com
                                  nullable: false
                                  readOnly: true
                                  type: string
                                employeeOrConceptEmployee:
                                  description: This field determines what the id belongs to. It may belong to an employee or a concept employee or no associated entity was found.
                                  enum:
                                    - employee
                                    - conceptEmployee
                                    - notFound
                                  nullable: false
                                  type: string
                                firstName:
                                  description: The first name of the initiator
                                  example: Ben
                                  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
                                lastName:
                                  description: The last name of the initiator
                                  example: Hur
                                  nullable: true
                                  readOnly: true
                                  type: string
                              type: object
                            requestedBy:
                              description: Information about the requestor / initiator.
                              nullable: false
                              properties:
                                email:
                                  description: The email adresses of the initiator
                                  example: test@test.com
                                  nullable: false
                                  readOnly: true
                                  type: string
                                firstName:
                                  description: The first name of the initiator
                                  example: Ben
                                  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
                                lastName:
                                  description: The last name of the initiator
                                  example: Hur
                                  nullable: true
                                  readOnly: true
                                  type: string
                              type: object
                            resultUrl:
                              description: The url on which the report can be found
                              example: https://portal.theselectionlab.com/candidate?email=<email>&user_type=recruiter
                              nullable: true
                              readOnly: true
                              type: string
                            status:
                              enum:
                                - sent
                                - completed
                                - denied
                                - shared
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 assessments
      tags:
        - Assessment
  "/providers/employers/{employerId}/assignedworkflows":
    get:
      description: |
        __Activity name:__ GetAssignedWorkflowsByEmployerId
            

        Get the list workflows that are assigned to the user or the role of the user.
      operationId: GetAssignedWorkflowsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: true
                          properties:
                            allowedTransitions:
                              description: |-
                                In this object the posible transitions are returned.
                                By sending a request to the `href` with the given `httpVerb` and one of the options given in `transitions` in the body. The workflow is transitioned to the given state.
                              items:
                                properties:
                                  description:
                                    description: The description of the transition (task)
                                    example: Controleer de vergoedingen
                                    maxLength: 256
                                    nullable: true
                                    readOnly: true
                                    type: string
                                  href:
                                    example: https://api.loket.nl/v2/providers/employers/workflows/{workflowId}/transition
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  httpVerb:
                                    enum:
                                      - POST
                                      - PATCH
                                      - PUT
                                    format: enum
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  transitions:
                                    example:
                                      - action: fabf3b25-abf9-4e8c-a8f7-81400d1b0e96
                                        description: Approve
                                      - action: abc31d45-f593-4d73-8078-6caba9cebdcc
                                        description: Reject
                                    items:
                                      properties:
                                        action:
                                          description: The unique identifier for the action to be taken
                                          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
                                        description:
                                          description: Description of the action
                                          example: Approve
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      type: object
                                    nullable: false
                                    readOnly: true
                                    type: array
                                type: object
                              nullable: true
                              readOnly: true
                              type: array
                            assignee:
                              description: A workflow is either assigned to a user or a role. A role can be filled by multiple users.
                              nullable: true
                              properties:
                                role:
                                  format: metadata
                                  nullable: true
                                  properties:
                                    description:
                                      description: A description of the role.
                                      example: Employer
                                      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
                                  type: object
                                user:
                                  format: metadata
                                  nullable: true
                                  properties:
                                    formattedName:
                                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                      example: Jong, I
                                      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
                                    initials:
                                      description: The initials of the user
                                      example: I
                                      maxLength: 6
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    lastName:
                                      description: The last name of the user
                                      example: Jong
                                      maxLength: 25
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    prefix:
                                      description: The prefix of the user
                                      example: de
                                      maxLength: 10
                                      nullable: true
                                      readOnly: true
                                      type: string
                                  type: object
                              type: object
                            data:
                              description: A JSON representation of the mutation/data regarding this workflow
                              example:
                                address:
                                  city: Leiden
                                  country:
                                    key: 1
                                  houseNumber: 12
                                  houseNumberAddition: D
                                  postalCode: 1234 AA
                                  street: Voordijk
                              format: JSON
                              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
                            initiatedBy:
                              format: metadata
                              nullable: false
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            initiatedOn:
                              example: 2019-11-23T11:14:06Z
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            lastModifiedBy:
                              format: metadata
                              nullable: false
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            lastModifiedOn:
                              description: date and time on which the last modification on the workflow was performed. This can be either by the system or a user.
                              example: 2019-11-23T11:14:06Z
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            status:
                              description: Indicates the status of the workflow as a whole.
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: The unique identifier
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: In progress
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              type: object
                            trigger:
                              description: |-
                                Indicates the trigger that started the workflow.

                                `trigger` is a metadata field within the employer context. Possible values can be managed by the user. 
                              format: metadata
                              nullable: false
                              properties:
                                description:
                                  example: Address change for employee
                                  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
                              readOnly: true
                              type: object
                            workflowTemplate:
                              description: |-
                                Indicates what workflow template was used to initiate the workflow.

                                `workflowTemplate` is a metadata field within the employer context. Possible values can be managed by the user. 
                              format: metadata
                              nullable: false
                              properties:
                                description:
                                  example: Approval by employer
                                  maxLength: 256
                                  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
                                version:
                                  description: The version of the workflow template this workflow was based on. Changes to a workflow template do not affect existing workflows.
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Workflows assigned to the user
      tags:
        - Workflows
  "/providers/employers/{employerId}/auditTrail/EmployeeData":
    get:
      description: |
        __Activity name :__ GetEmployeeDataAuditTrailByEmployerId

        Get the mutations for the all the tables linked to the employee (this includes employment and underlying entities).
      operationId: GetEmployeeDataAuditTrailByEmployerId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 employer
          in: path
          name: employerId
          required: true
          schema:
            format: uuid
            type: string
        - description: The start date
          in: query
          name: startDate
          required: true
          schema:
            example: 2020-08-01
            pattern: date
            type: string
        - description: The end date
          in: query
          name: endDate
          required: true
          schema:
            example: 2020-08-31
            pattern: 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:
                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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            employee:
                              properties:
                                employeeNumber:
                                  description: The employee number to uniquely identify a employee within an employer.
                                  example: 156
                                  format: int32
                                  nullable: true
                                  readOnly: true
                                  type: integer
                                id:
                                  description: The unique identifier (GUID/UUID)
                                  example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                  format: uuid
                                  nullable: true
                                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                  readOnly: true
                                  type: string
                                name:
                                  description: The name of the employee
                                  example: Bergen
                                  maxLength: 25
                                  nullable: true
                                  readOnly: true
                                  type: string
                              type: object
                            employer:
                              properties:
                                companyName:
                                  description: Name of the company
                                  example: Voorbeeld B.V.
                                  maxLength: 70
                                  nullable: false
                                  readOnly: false
                                  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 (GUID/UUID)
                                  example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                  format: uuid
                                  nullable: true
                                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                  readOnly: true
                                  type: string
                              type: object
                            employment:
                              properties:
                                id:
                                  description: The unique identifier (GUID/UUID)
                                  example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                  format: uuid
                                  nullable: true
                                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                  readOnly: true
                                  type: string
                                startDate:
                                  description: The date on which this employment starts.
                                  example: 2018-01-01
                                  format: date
                                  nullable: true
                                  readOnly: true
                                  type: string
                              type: object
                            entity:
                              description: |
                                The table on which the change took place
                              format: metadata
                              properties:
                                key:
                                  description: The key of the entity
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: Description of table
                                  example: employee
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                              type: object
                            field:
                              description: |
                                The application that performed the mutation
                              format: metadata
                              properties:
                                key:
                                  description: The key of the field
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  description: Description of the field
                                  example: Achternaam
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            identification:
                              description: |
                                The identification of the entity record that was changed
                              nullable: true
                              properties:
                                description:
                                  description: Extra identifying information for the mutation
                                  example: Datum ingang 03-03-2005
                                  maxLength: 255
                                  nullable: true
                                  readOnly: true
                                  type: string
                              type: object
                            mutationOrigin:
                              description: |
                                The origin of the mutation
                                For example:
                                * By user * Automatich process * Collective change * Import
                              format: metadata
                              properties:
                                key:
                                  description: The key of the mutationOrigin
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: Description of the mutationOrigin
                                  example: Import
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            mutationType:
                              description: |
                                The type of mutation


                                  * create (toevoegen)
                                  * update (wijzigen)
                                  * delete (verwijderen)
                              format: metadata
                              properties:
                                key:
                                  description: The key of the mutationType
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: Description of the mutationType
                                  example: toevoegen
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            newValue:
                              description: |-
                                The value of the field after the change. 
                                Incase of an delete the nieuwValue will be NULL.
                              example: Hermans
                              maxLength: 250
                              nullable: true
                              readOnly: true
                              type: string
                            oldValue:
                              description: |-
                                The value befor the change. 
                                Incase of an create the oldValue will be NULL.
                              example: Hermanss
                              maxLength: 250
                              nullable: true
                              readOnly: true
                              type: string
                            performedBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            timeStamp:
                              description: The time the mutation was performed
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the employee data audit trail
      tags:
        - Audit trail
  "/providers/employers/{employerId}/authorizations":
    get:
      description: |
        __Activity name :__ GetAuthorizationsByEmployerId

        Get the array of activities the user is authenticated for with regard to the specified employer
      operationId: GetAuthorizationsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            name:
                              type: string
                          type: object
                        type: array
                    type: object
            application/json;version=2019-02-11:
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            description:
                              example: GetJournalRunsByPayrollAdministrationId
                              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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 authorized activities with regard to the employer
      tags:
        - Authorizations
  "/providers/employers/{employerId}/benefitinkindtypes":
    get:
      description: |
        __Activity name :__ GetBenefitInKindTypesByEmployerId

        Get a list of the benefit in kind types for an employer.

        __Note:__ The benefit in kind types defined at the employer level can be used as value for the field typeOfBenefitInKind in the BenefitInKind resource at the employment level.
      operationId: GetBenefitInKindTypesByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 benefit in kind types for an employer
      tags:
        - Benefit in kind type
    post:
      description: |
        __Activity name :__ PostBenefitInKindTypeByEmployerId
      operationId: PostBenefitInKindTypeByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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
        description: Add an benefit in kind type
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 an benefit in kind type for an employer
      tags:
        - Benefit in kind type
  "/providers/employers/{employerId}/billableitems":
    get:
      description: |
        __Activity name :__ GetBillableItemsByEmployerId

        Get a list of all billable items for the employer. 
      operationId: GetBillableItemsByEmployerId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 employer
          in: path
          name: employerId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            employer:
                              description: |
                                Data about the employer.
                              nullable: false
                              properties:
                                companyName:
                                  example: Janssen B.V.
                                  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
                            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
                            issuedTo:
                              description: |
                                Information about the person to whom the billable item was issued. If the person is still active then the person object is filled. if the person is no longer active, the name field is filled.
                              nullable: false
                              properties:
                                name:
                                  example: B. Janssen
                                  maxLength: 50
                                  nullable: false
                                  readOnly: false
                                  type: string
                                person:
                                  description: |
                                    Information on the person to whom the billable item was issued to. 
                                  nullable: true
                                  properties:
                                    firstName:
                                      description: |
                                        The first name, given name, forename or Christian name as part of a persons personal name.
                                      example: Susan
                                      maxLength: 28
                                      minLength: 1
                                      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: 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
                                      example: S.L.
                                      maxLength: 6
                                      minLength: 1
                                      nullable: false
                                      readOnly: false
                                      type: string
                                    lastName:
                                      description: |
                                        The last name, family name or surname as part of a persons personal name.
                                      example: Bergen
                                      maxLength: 25
                                      minLength: 1
                                      nullable: false
                                      readOnly: false
                                      type: string
                                    lastNamePartner:
                                      description: The last name of the employee's partner.
                                      example: Wiel
                                      maxLength: 25
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    prefix:
                                      description: |
                                        The prefix to the last name
                                      example: van
                                      maxLength: 10
                                      minLength: 1
                                      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: true
                                      type: string
                                  type: object
                              type: object
                            providerId:
                              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
                            requestedBy:
                              description: |
                                Data on who has requested the billable item. If the user is still active then the user object is filled. if the user is no longer active, the name field is filled.
                              nullable: false
                              properties:
                                name:
                                  description: |
                                    The name of the user
                                  example: B. Janssen
                                  nullable: true
                                  readOnly: true
                                  type: string
                                user:
                                  description: |
                                    Data on who has requested the billable item. 
                                  nullable: true
                                  properties:
                                    firstName:
                                      description: The first name of the user
                                      example: Susan
                                      maxLength: 28
                                      minLength: 1
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    formattedName:
                                      description: Formatted name of the user.
                                      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 user
                                      example: S.L.
                                      maxLength: 6
                                      minLength: 1
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    lastName:
                                      description: The last name of the user
                                      example: Bergen
                                      maxLength: 25
                                      minLength: 1
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    prefix:
                                      description: The prefix of the user
                                      example: van
                                      maxLength: 10
                                      minLength: 1
                                      nullable: true
                                      readOnly: true
                                      type: string
                                  type: object
                              type: object
                            requestedDate:
                              description: |
                                The date on which the billable item is requested.
                              example: 2022-04-12
                              format: date
                              nullable: false
                              readOnly: true
                              type: string
                            requestedItem:
                              description: |
                                Details on the requested item.
                              nullable: false
                              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
                                itemType:
                                  description: |
                                    Details on the requested item.
                                  nullable: false
                                  properties:
                                    description:
                                      description: The description of the item type.
                                      example: Preboarding traject
                                      nullable: false
                                      type: string
                                    id:
                                      description: The item type of the billed item.
                                      example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                      format: uuid
                                      nullable: false
                                      pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                      type: string
                                  type: object
                                preboardingTrajectory:
                                  description: |
                                    This object contains item type specific data
                                  nullable: true
                                  properties:
                                    dateLastModification:
                                      description: The date on which the status was last modified
                                      example: 2022-04-12
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    status:
                                      description: |
                                        The status of the preboardingTraject.
                                      enum:
                                        - open
                                        - completed
                                        - endedPrematurely
                                      example: open
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 billable items
      tags:
        - Billable item
  "/providers/employers/{employerId}/conceptemployees":
    get:
      description: |
        __Activity name :__ GetConceptEmployeesByEmployerId

        Get a list of all concept employee for the given employer. Concept employee can be used as a template/prefill when creating a new employee/employment.  <br/> This function may also be used in case one does not have all the required fields to create a new employee/employment. The validations are disabled for a concept employee allowing one to create a concept employee filling only a subset of available fields, then later "promoting" the Concept employee in loket.nl to employee/employment. 
      operationId: GetConceptEmployeesByEmployerId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 employer
          in: path
          name: employerId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            creationDate:
                              description: The date time on which the record was added (ISO-8601)
                              example: 2018-05-08
                              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: 1995-05-21
                                      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: 2019-05-31
                                  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: 2019-01-01
                                  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

                                    `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

                                    `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: 2012-05-01
                                  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`

                                    `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`

                                    `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: 2019-06-01
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                startDate:
                                  description: The date on which this employment starts.
                                  example: 2019-01-01
                                  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: 2018-05-08
                                  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.
                                  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.

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

                                    `distributionUnit` 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: 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.

                                    `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)
                                      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.

                                    `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. 
                                  example: true
                                  nullable: true
                                  readOnly: false
                                  type: boolean
                                grossWage:
                                  description: |
                                    The gross wage for the employee
                                  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.
                                  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
                                  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.
                                  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. 

                                    `payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                                  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.

                                    `payScale` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                                  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.

                                    `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)
                                      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.

                                    `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. <br /> Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                                  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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 concept employee for an employer
      tags:
        - Concept employee
    post:
      description: |
        __Activity name :__ PostConceptEmployeeByEmployerId

        Create a concept employee for an employer

        * Possible options (metadata) for generic fields of the type "metadata" can be acquired (GET) by adding `/metadata` to the URL.
        * Possible options dependent on a specific payrollAdministration can be acquired via `../providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}`.
        * Possible options for payGrade can be acquired via `../providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}`.
        A `payGrade` has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request to GET `../providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}/paygrade/{payGradeKey}`. This endpoint has the optional parameter "date" that may be used to specifying a measure date.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults` to the POST URL. 

                
        Default values that are dependent on the selected payroll administration can be acquired by adding `/providers/employers/conceptemployees/defaults/payrolladministration/{payrollAdministrationId}` to the POST URL.

        __NonPayrollAdministrations__ For nonPayrollAdministrations the equivalent MetaData-endpoints are also available as described above. However NO specific defaults endpoint is available for the nonPayrollAdministration.
      operationId: PostConceptEmployeeByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-05-08
                  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: 1995-05-21
                          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: 2019-05-31
                      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: 2019-01-01
                      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

                        `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

                        `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: 2012-05-01
                      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`

                        `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`

                        `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: 2019-06-01
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    startDate:
                      description: The date on which this employment starts.
                      example: 2019-01-01
                      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: 2018-05-08
                      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.
                      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.

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

                        `distributionUnit` 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: 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.

                        `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)
                          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.

                        `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. 
                      example: true
                      nullable: true
                      readOnly: false
                      type: boolean
                    grossWage:
                      description: |
                        The gross wage for the employee
                      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.
                      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
                      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.
                      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. 

                        `payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                      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.

                        `payScale` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                      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.

                        `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)
                          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.

                        `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. <br /> Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                      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 create to the employer.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-05-08
                            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: 1995-05-21
                                    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: 2019-05-31
                                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: 2019-01-01
                                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

                                  `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

                                  `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: 2012-05-01
                                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`

                                  `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`

                                  `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: 2019-06-01
                                format: date
                                nullable: true
                                readOnly: false
                                type: string
                              startDate:
                                description: The date on which this employment starts.
                                example: 2019-01-01
                                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: 2018-05-08
                                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.
                                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.

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

                                  `distributionUnit` 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: 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.

                                  `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)
                                    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.

                                  `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. 
                                example: true
                                nullable: true
                                readOnly: false
                                type: boolean
                              grossWage:
                                description: |
                                  The gross wage for the employee
                                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.
                                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
                                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.
                                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. 

                                  `payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                                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.

                                  `payScale` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                                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.

                                  `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)
                                    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.

                                  `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. <br /> Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                                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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 concept employee for an employer
      tags:
        - Concept employee
  "/providers/employers/{employerId}/conceptemployees/selfservice":
    get:
      description: |
        __Activity name :__ GetConceptEmployeeSelfServiceByEmployerId

        Get a list of all the Concept employee's and their status regarding to ESS (werknemer.loket).
      operationId: GetConceptEmployeeSelfServiceByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 Concept employee's and their ESS (WNL) status
      tags:
        - Concept employee self service
  "/providers/employers/{employerId}/contractcodes":
    get:
      description: |
        __Activity name :__ GetContractCodesByEmployerId


        Get a list of the contract codes for an employer.

        __Note:__ The contract codes defined at the employer level can be used as value for the field contractCode in the WorkingHours and ConceptEmployee resource.
      operationId: GetContractCodesByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 contract codes for an employer
      tags:
        - Contract code
    post:
      description: |
        __Activity name :__ PostContractCodeByEmployerId
      operationId: PostContractCodeByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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
        description: Add a contract code
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 contract code for an employer
      tags:
        - Contract code
  "/providers/employers/{employerId}/customfields":
    get:
      description: |
        __Activity name :__ GetCustomFieldsByEmployerId

        Get a list of the custom fields for an employer.

        __Note:__ The custom fields defined at the employer level can be used at the employee and employment level.
      operationId: GetCustomFieldsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 custom fields for an employer
      tags:
        - Custom field
    post:
      description: |
        __Activity name :__ PostCustomFieldByEmployerId
      operationId: PostCustomFieldByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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
        description: Add a custom field
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 custom field for an employer
      tags:
        - Custom field
  "/providers/employers/{employerId}/customholidays":
    get:
      description: |
        __Activity name :__ GetCustomHolidaysByEmployerId

        Get a list of the custom holidays for an employer.

        __Note:__ The custom holidays defined at the employer level can be used at the employee and employment level.
      operationId: GetCustomHolidaysByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2021-01-01
                              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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 custom holidays for an employer
      tags:
        - Custom holiday
    post:
      description: |
        __Activity name :__ PostCustomHolidayByEmployerId
      operationId: PostCustomHolidayByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2021-01-01
                  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
        description: Add a custom holiday
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2021-01-01
                            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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 custom holiday for an employer
      tags:
        - Custom holiday
  "/providers/employers/{employerId}/dashboard":
    get:
      description: |
        __Activity name :__ GetEmployerDashboardByEmployerId

        Get the url for the Qlik dashboard for this employer.
        Please note: the Qlik dashboard is only accessible for users with an assigned Qlik dashboard licenses.
      operationId: GetEmployerDashboardByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          dashboardLocation:
                            description: The location of the Qlik employer dashboard.
                            example: http://qlik01.loket.nl/loket-api/sense/app/00000000-0000-0000-0000-000000000000/sheet/00000000-0000-0000-0000-000000000000/state/analysis?qlikTicket=0000000000000000
                            format: url
                            nullable: true
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Dashboard of an employer
      tags:
        - Employer dashboard
  "/providers/employers/{employerId}/dashboardLicenses":
    get:
      description: |
        __Activity name :__ GetDashboardLicensesByEmployerId


         Get the list dashboard licenses
      operationId: GetDashboardLicensesByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            license:
                              nullable: true
                              properties:
                                user:
                                  nullable: false
                                  properties:
                                    personalDetails:
                                      nullable: false
                                      properties:
                                        firstName:
                                          description: The first name of the user
                                          example: Susan
                                          maxLength: 28
                                          minLength: 1
                                          nullable: true
                                          readOnly: true
                                          type: string
                                        initials:
                                          description: The initials of the user
                                          example: S.L.
                                          maxLength: 6
                                          minLength: 1
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        lastName:
                                          description: The last name of the user
                                          example: Bergen
                                          maxLength: 25
                                          minLength: 1
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        prefix:
                                          description: The prefix of the user
                                          example: van
                                          maxLength: 10
                                          minLength: 1
                                          nullable: true
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    userId:
                                      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
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the list dashboard licenses
      tags:
        - Dashboard licenses
    put:
      description: |
        __Activity name:__ PutDashboardLicensesByEmployerId

        Edit the dashboard licenses

        __Metadata :__ There is no metadata endpoint for this resource.
      operationId: PutDashboardLicensesByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              items:
                properties:
                  license:
                    nullable: true
                    properties:
                      user:
                        nullable: false
                        properties:
                          personalDetails:
                            nullable: false
                            properties:
                              firstName:
                                description: The first name of the user
                                example: Susan
                                maxLength: 28
                                minLength: 1
                                nullable: true
                                readOnly: true
                                type: string
                              initials:
                                description: The initials of the user
                                example: S.L.
                                maxLength: 6
                                minLength: 1
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Bergen
                                maxLength: 25
                                minLength: 1
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: van
                                maxLength: 10
                                minLength: 1
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          userId:
                            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
                    type: object
                type: object
              type: array
        description: Edit dashboard users
        required: true
      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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            license:
                              nullable: true
                              properties:
                                user:
                                  nullable: false
                                  properties:
                                    personalDetails:
                                      nullable: false
                                      properties:
                                        firstName:
                                          description: The first name of the user
                                          example: Susan
                                          maxLength: 28
                                          minLength: 1
                                          nullable: true
                                          readOnly: true
                                          type: string
                                        initials:
                                          description: The initials of the user
                                          example: S.L.
                                          maxLength: 6
                                          minLength: 1
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        lastName:
                                          description: The last name of the user
                                          example: Bergen
                                          maxLength: 25
                                          minLength: 1
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        prefix:
                                          description: The prefix of the user
                                          example: van
                                          maxLength: 10
                                          minLength: 1
                                          nullable: true
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    userId:
                                      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
                              type: object
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the dashboard license
      tags:
        - Dashboard licenses
  "/providers/employers/{employerId}/datanewbusinesstoken":
    get:
      description: |
        __Activity name :__ GetDataNewBusinessTokenByEmployerId

        Get 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. 
      operationId: GetDataNewBusinessTokenByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 for an employer
      tags:
        - Data New Business
  "/providers/employers/{employerId}/departments":
    get:
      description: |
        __Activity name :__ GetDepartmentsByEmployerId

        Get a list of all departments for the employer. This is the point where the departments available for use at employment level (organizational entity) are managed.
      operationId: GetDepartmentsByEmployerId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 employer
          in: path
          name: employerId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            code:
                              description: |
                                The visible identifier of the department.
                              example: 2
                              format: int32
                              nullable: false
                              readOnly: false
                              type: integer
                            description:
                              description: |
                                The visible description (i.e. name) of the department.
                              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)
                              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.
                              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)
                                  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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 departments
      tags:
        - Departments
    post:
      description: |
        __Activity name:__ PostDepartmentByEmployerId
            

        Create a department for an employer

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults:__ No default values
      operationId: PostDepartmentByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: |
                    The visible identifier of the department.
                  example: 2
                  format: int32
                  nullable: false
                  readOnly: false
                  type: integer
                description:
                  description: |
                    The visible description (i.e. name) of the department.
                  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)
                  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.
                  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)
                      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 add to the employer.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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.
                            example: 2
                            format: int32
                            nullable: false
                            readOnly: false
                            type: integer
                          description:
                            description: |
                              The visible description (i.e. name) of the department.
                            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)
                            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.
                            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)
                                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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 department for an employer
      tags:
        - Departments
  "/providers/employers/{employerId}/documents":
    get:
      description: |
        __Activity name :__ GetDocumentsByEmployerId

        Get a list of documents within the employer dossier (werkgeverdossier). Via Qwoater.
      operationId: GetDocumentsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - properties:
                                attribute:
                                  description: |
                                    The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk
                                  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
                                  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
                                  example: 2018-05-08
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                dateOfSubmission:
                                  description: |
                                    The time at which document was submitted. Qwoater: CreationDate
                                  example: 2018-05-08
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                description:
                                  description: |
                                    The description defined by the submitter. Qwoater: Docfield 33 Omschrijving
                                  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
                                  example: Bowls, John
                                  maxLength: 4000
                                  nullable: true
                                  readOnly: true
                                  type: string
                                year:
                                  description: |
                                    The year the document relates to. Qwoater: Docfield 86 Jaar
                                  example: 2017
                                  format: int32
                                  maximum: 9999
                                  minimum: 1000
                                  nullable: true
                                  readOnly: false
                                  type: integer
                            - properties:
                                filename:
                                  description: |
                                    The name of the file. Qwoater: Filename
                                  example: BowlsJohn.pdf
                                  maxLength: 255
                                  minLength: 1
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employer dossier documents
      tags:
        - Employer dossier
    post:
      description: |
        __Activity name :__ PostDocumentByEmployerId

        __Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.

        Upload a document within the employer dossier (werkgeverdossier). Via Qwoater.
      operationId: PostDocumentByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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
                          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
                          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
                          example: 2018-05-08
                          format: date
                          nullable: true
                          readOnly: false
                          type: string
                        dateOfSubmission:
                          description: |
                            The time at which document was submitted. Qwoater: CreationDate
                          example: 2018-05-08
                          format: date
                          nullable: false
                          readOnly: true
                          type: string
                        description:
                          description: |
                            The description defined by the submitter. Qwoater: Docfield 33 Omschrijving
                          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
                          example: Bowls, John
                          maxLength: 4000
                          nullable: true
                          readOnly: true
                          type: string
                        year:
                          description: |
                            The year the document relates to. Qwoater: Docfield 86 Jaar
                          example: 2017
                          format: int32
                          maximum: 9999
                          minimum: 1000
                          nullable: true
                          readOnly: false
                          type: integer
                    - properties:
                        filename:
                          description: |
                            The name of the file. Qwoater: Filename
                          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
                    sendEmailNotification:
                      default: false
                      description: Indicate whether to send an email to the employees.
                      example: true
                      nullable: true
                      readOnly: false
                      type: boolean
        description: Document to be uploaded for the employer.
        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employer dossier
      tags:
        - Employer dossier
  "/providers/employers/{employerId}/documents/authorizations":
    get:
      description: |
        __Activity name :__ GetDossierAuthorizationsByEmployerId

        Get the authorizations per role and per category. Via Qwoater.
      operationId: GetDossierAuthorizationsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            canWrite:
                              description: |
                                This object describes the authorization per category for each role.
                              nullable: false
                              properties:
                                departmentManager:
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                employee:
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                employer:
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                provider:
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                              type: object
                            category:
                              description: |
                                The category
                              example: Arbeidsovereenkomst
                              nullable: false
                              readOnly: false
                              type: string
                            isAuthorizaionEditRestricted:
                              description: |
                                Indicates whether the authorizations of the category can be edited or not.
                              nullable: false
                              readOnly: true
                              type: boolean
                            isTemplate:
                              description: |
                                Indicates whether the category is a template.
                              nullable: false
                              readOnly: true
                              type: boolean
                        type: array
                    type: object
          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: List of authorizations
      tags:
        - Document Management
    put:
      description: |
        __Activity name:__ PutDossierAuthorizationsByEmployerId

        Edit the authorizations. Categories not included in de request will be set to inaccessible for all roles.
      operationId: PutDossierAuthorizationsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                  canWrite:
                    description: |
                      This object describes the authorization per category for each role.
                    nullable: false
                    properties:
                      departmentManager:
                        example: false
                        nullable: false
                        readOnly: false
                        type: boolean
                      employee:
                        example: false
                        nullable: false
                        readOnly: false
                        type: boolean
                      employer:
                        example: false
                        nullable: false
                        readOnly: false
                        type: boolean
                      provider:
                        example: true
                        nullable: false
                        readOnly: false
                        type: boolean
                    type: object
                  category:
                    description: |
                      The category
                    example: Arbeidsovereenkomst
                    nullable: false
                    readOnly: false
                    type: string
                  isAuthorizaionEditRestricted:
                    description: |
                      Indicates whether the authorizations of the category can be edited or not.
                    nullable: false
                    readOnly: true
                    type: boolean
                  isTemplate:
                    description: |
                      Indicates whether the category is a template.
                    nullable: false
                    readOnly: true
                    type: boolean
              type: array
        description: The request body contains an array of objects containing a `employment` and an `action` field.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the authorization matrix
      tags:
        - Document Management
  "/providers/employers/{employerId}/documents/completedossier":
    delete:
      description: |
        __Activity name:__ DeleteCompleteDossierByEmployerId

        Delete all documents in the dossier of an employer and the underlying employments
      operationId: DeleteCompleteDossierByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Delete complete dossier
      tags:
        - Document Management
  "/providers/employers/{employerId}/documents/completedossier/initiate":
    post:
      description: |
        __Activity name:__ PostInitiateCompleteDossierByEmployerId

        Initiate the proces to generate a zip file containing the complete dossier. (via Qwoater)
      operationId: PostInitiateCompleteDossierByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
        "202":
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
          description: Initiated
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Generate complete dossier
      tags:
        - Document Management
  "/providers/employers/{employerId}/documents/{documentId}":
    delete:
      description: |
        __Activity name:__ DeleteDocumentByEmployerIdAndDocumentId

        Delete a document in the employer dossier
      operationId: DeleteDocumentByEmployerIdAndDocumentId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of the employer 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 <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employer dossier
      tags:
        - Employer dossier
    get:
      description: |
        __Activity name :__ GetDocumentByEmployerIdAndDocumentId

        Download the file of a given employer dossier entry. Via Qwoater.
      operationId: GetDocumentByEmployerIdAndDocumentId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of the employer 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 <TOKEN>
            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 employer dossier document
      tags:
        - Employer dossier
    put:
      description: |
        __Activity name:__ PutDocumentByEmployerIdAndDocumentId

        Edit the details for a document in the employer dossier
      operationId: PutDocumentByEmployerIdAndDocumentId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of the employer 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 <TOKEN>
            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
                  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
                  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
                  example: 2018-05-08
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                dateOfSubmission:
                  description: |
                    The time at which document was submitted. Qwoater: CreationDate
                  example: 2018-05-08
                  format: date
                  nullable: false
                  readOnly: true
                  type: string
                description:
                  description: |
                    The description defined by the submitter. Qwoater: Docfield 33 Omschrijving
                  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
                  example: Bowls, John
                  maxLength: 4000
                  nullable: true
                  readOnly: true
                  type: string
                year:
                  description: |
                    The year the document relates to. Qwoater: Docfield 86 Jaar
                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of an employer dossier document
      tags:
        - Employer dossier
  "/providers/employers/{employerId}/documents/{documentId}/audittrail":
    get:
      description: |
        __Activity name :__ GetAuditTrailByEmployerIdAndDocumentId

        Get audittrail for the document in the employer dossier.
      operationId: GetAuditTrailByEmployerIdAndDocumentId
      parameters:
        - description: The unique identifier of the employer dossier document
          in: path
          name: documentId
          required: true
          schema:
            type: string
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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
                              example: ""
                              nullable: true
                              readOnly: true
                              type: string
                            category:
                              description: |
                                Qwoater: DocumentType
                              example: ""
                              nullable: false
                              readOnly: true
                              type: string
                            dateOfAlert:
                              description: |
                                The time the declaration was submitted. Qwoater: Signaleringsdatum
                              example: 2018-05-08
                              format: date
                              nullable: true
                              readOnly: true
                              type: string
                            description:
                              description: |
                                Qwoater: Omschrijving
                              example: VSP004
                              nullable: false
                              readOnly: true
                              type: string
                            endUser:
                              description: |
                                Qwoater: EndUser
                              example: Hur, Ben
                              nullable: false
                              readOnly: true
                              type: string
                            event:
                              description: |
                                Qwoater: Event
                              example: Audittrail opgevraagd
                              nullable: false
                              readOnly: true
                              type: string
                            eventDate:
                              description: |
                                The time the declaration was submitted. Qwoater: AuditEventDate
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            role:
                              description: |
                                Qwoater: Role
                              example: Provider
                              nullable: false
                              readOnly: true
                              type: string
                            year:
                              description: |
                                Qwoater: Jaar
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employer dossier
      tags:
        - Employer dossier
  "/providers/employers/{employerId}/documenttemplates":
    get:
      description: |
        __Activity name :__ GetDocumentTemplatesByEmployerId

        Get a list of document templates within the employer dossier (werkgeverdossier). Via Qwoater. Note that the 'category' field contains the category of the template.
      operationId: GetDocumentTemplatesByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - properties:
                                attribute:
                                  description: |
                                    The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk
                                  example: VSP004
                                  maxLength: 250
                                  nullable: true
                                  readOnly: false
                                  type: string
                                dateOfAlert:
                                  description: |
                                    The time at which document will alerted for cancellation. Qwoater: AlertDate
                                  example: 2018-05-08
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                description:
                                  description: |
                                    The description defined by the submitter. Qwoater: Docfield 33 Omschrijving
                                  example: Copy of id card
                                  maxLength: 250
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                qwoaterDocumentId:
                                  description: Qwoater documentId
                                  example: ""
                                  format: uuid
                                  nullable: false
                                  readOnly: true
                                  type: string
                                year:
                                  description: |
                                    The year the document relates to. Qwoater: Docfield 86 Jaar
                                  example: 2017
                                  format: int32
                                  maximum: 9999
                                  minimum: 1000
                                  nullable: true
                                  readOnly: false
                                  type: integer
                            - properties:
                                dateOfSubmission:
                                  description: |
                                    The time at which document was submitted. Qwoater: CreationDate
                                  example: 2018-05-08
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                filename:
                                  description: |
                                    The name of the file. Qwoater: Filename
                                  example: BowlsJohn.pdf
                                  maxLength: 255
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                targetCategory:
                                  description: |
                                    The target category will be used to set the category for a document which is generated with the template. Provided value must be a valid metadata option. Qwoater: DocumentType
                                  example: Arbeidsovereenkomst
                                  format: metadata
                                  maxLength: 4000
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 document templates
      tags:
        - Document template
    post:
      description: |
        __Activity name :__ PostDocumentTemplateByEmployerId

        __Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.

        Upload a document template within the employer dossier (werkgeverdossier). Via Qwoater.
      operationId: PostDocumentTemplateByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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
                          example: VSP004
                          maxLength: 250
                          nullable: true
                          readOnly: false
                          type: string
                        dateOfAlert:
                          description: |
                            The time at which document will alerted for cancellation. Qwoater: AlertDate
                          example: 2018-05-08
                          format: date
                          nullable: true
                          readOnly: false
                          type: string
                        description:
                          description: |
                            The description defined by the submitter. Qwoater: Docfield 33 Omschrijving
                          example: Copy of id card
                          maxLength: 250
                          minLength: 1
                          nullable: false
                          readOnly: false
                          type: string
                        qwoaterDocumentId:
                          description: Qwoater documentId
                          example: ""
                          format: uuid
                          nullable: false
                          readOnly: true
                          type: string
                        year:
                          description: |
                            The year the document relates to. Qwoater: Docfield 86 Jaar
                          example: 2017
                          format: int32
                          maximum: 9999
                          minimum: 1000
                          nullable: true
                          readOnly: false
                          type: integer
                    - properties:
                        dateOfSubmission:
                          description: |
                            The time at which document was submitted. Qwoater: CreationDate
                          example: 2018-05-08
                          format: date
                          nullable: false
                          readOnly: true
                          type: string
                        filename:
                          description: |
                            The name of the file. Qwoater: Filename
                          example: BowlsJohn.pdf
                          maxLength: 255
                          minLength: 1
                          nullable: false
                          readOnly: false
                          type: string
                        targetCategory:
                          description: |
                            The target category will be used to set the category for a document which is generated with the template. Provided value must be a valid metadata option. Qwoater: DocumentType
                          example: Arbeidsovereenkomst
                          format: metadata
                          maxLength: 4000
                          nullable: false
                          readOnly: false
                          type: string
                - properties:
                    file:
                      description: base64 encoded document file.
                      example: YQ==
                      nullable: false
                      readOnly: false
                      type: string
        description: Document template to be uploaded for the employer.
        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 template to the employer dossier
      tags:
        - Document template
  "/providers/employers/{employerId}/documenttemplates/{documentId}":
    delete:
      description: |
        __Activity name:__ DeleteDocumentTemplateByEmployerIdAndDocumentId

        Delete a document template in the employer dossier
      operationId: DeleteDocumentTemplateByEmployerIdAndDocumentId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of the document template
          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 <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 template in the employer dossier
      tags:
        - Document template
    get:
      description: |
        __Activity name :__ GetDocumentTemplateByEmployerIdAndDocumentId

        Download the document template of a given template entry. Via Qwoater.
      operationId: GetDocumentTemplateByEmployerIdAndDocumentId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of the document template
          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 <TOKEN>
            pattern: ^Bearer\s[\w-]+$
            type: string
      responses:
        "200":
          content:
            application/vnd.openxmlformats-officedocument.wordprocessingml.document:
              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 template document
      tags:
        - Document template
    put:
      description: |
        __Activity name:__ PutDocumentTemplateByEmployerIdAndDocumentId

        Edit the details for a document template in the employer dossier
      operationId: PutDocumentTemplateByEmployerIdAndDocumentId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of the document template
          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 <TOKEN>
            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
                  example: VSP004
                  maxLength: 250
                  nullable: true
                  readOnly: false
                  type: string
                dateOfAlert:
                  description: |
                    The time at which document will alerted for cancellation. Qwoater: AlertDate
                  example: 2018-05-08
                  format: date
                  nullable: true
                  readOnly: false
                  type: string
                description:
                  description: |
                    The description defined by the submitter. Qwoater: Docfield 33 Omschrijving
                  example: Copy of id card
                  maxLength: 250
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                qwoaterDocumentId:
                  description: Qwoater documentId
                  example: ""
                  format: uuid
                  nullable: false
                  readOnly: true
                  type: string
                year:
                  description: |
                    The year the document relates to. Qwoater: Docfield 86 Jaar
                  example: 2017
                  format: int32
                  maximum: 9999
                  minimum: 1000
                  nullable: true
                  readOnly: false
                  type: integer
        description: Document template 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of an document template
      tags:
        - Document template
  "/providers/employers/{employerId}/documenttemplates/{documentId}/generatedocuments":
    post:
      description: |
        __Activity name :__ PostGenerateDocumentsByEmployerIdAndDocumentId

        __Metadata:__ Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).

        Generate documents for a selection of employments and store it in the employment dossier. Via Qwoater. (One document is generated and stored for each selected employment)
      operationId: PostGenerateDocumentsByEmployerIdAndDocumentId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                - properties:
                    attribute:
                      description: |
                        The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk
                      example: VSP004
                      maxLength: 250
                      nullable: true
                      readOnly: false
                      type: string
                    dateOfAlert:
                      description: |
                        The date at which document will alerted for cancellation. Qwoater: AlertDate
                      example: 2018-05-08
                      format: date
                      nullable: true
                      readOnly: false
                      type: string
                    description:
                      description: |
                        The description defined by the submitter. Qwoater: Docfield 33 Omschrijving
                      example: Copy of id card
                      maxLength: 250
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    filename:
                      description: |
                        The name of the file. Qwoater: Filename
                      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.
                      example: 2020-05-08
                      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
                      example: 2017
                      format: int32
                      maximum: 9999
                      minimum: 1000
                      nullable: true
                      readOnly: false
                      type: integer
                - properties:
                    employmentIds:
                      items:
                        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
                      type: array
                    sendEmailNotification:
                      default: false
                      description: Indicate whether to send an email to the employees.
                      example: true
                      nullable: true
                      readOnly: false
                      type: boolean
        description: Metadata for the document to be generated.
        required: true
      responses:
        "202":
          description: OK. The process of generating documents has started.
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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 documents for selected employments
      tags:
        - Generate document
  "/providers/employers/{employerId}/educationfurtherindications":
    get:
      description: |
        __Activity name :__ GetEducationFurtherIndicationsByEmployerId

        Get a list of the education further indications for an employer.

        __Note:__ The education further indications defined at the employer level can be used as value for the field furtherIndication in the Education resource at the employee level.
      operationId: GetEducationFurtherIndicationsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 education further indications for an employer
      tags:
        - Education further indication
    post:
      description: |
        __Activity name :__ PostEducationFurtherIndicationByEmployerId
      operationId: PostEducationFurtherIndicationByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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
        description: Add an education further indication
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 an education further indication for an employer
      tags:
        - Education further indication
  "/providers/employers/{employerId}/educationtypes":
    get:
      description: |
        __Activity name :__ GetEducationTypesByEmployerId

        Get a list of the education types for an employer.

        __Note:__ The education types defined at the employer level can be used as value for the field typeOfEducation in the Education resource at the employee level.
      operationId: GetEducationTypesByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 education types for an employer
      tags:
        - Education type
    post:
      description: |
        __Activity name :__ PostEducationTypeByEmployerId
      operationId: PostEducationTypeByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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
        description: Add an education type
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 an education type for an employer
      tags:
        - Education type
  "/providers/employers/{employerId}/emailidentities":
    get:
      description: |
        __Activity name:__ GetEmailIdentitiesByEmployerId
            

        Get the list of EmailIdentities for an employer. 
      operationId: GetEmailIdentitiesByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: true
                          properties:
                            dkimTokens:
                              items:
                                description: The Tokens which should be registred
                                example: u6deqmqhlgn3wxslcp4cugcz7ognh4gt
                                type: string
                              nullable: true
                              readOnly: true
                              type: array
                            emailIdentity:
                              description: The emailIdentity that can be used when sending email.
                              example: provider.com
                              nullable: false
                              readOnly: false
                              type: string
                            emailIdentityType:
                              description: The type of the set emailIdentity
                              enum:
                                - DOMAIN
                              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
                            isDkimVerified:
                              description: Indicates whether the EmailIdentity has passed Spf verfication.
                              example: true
                              nullable: false
                              readOnly: true
                              type: boolean
                            isSpfVerified:
                              description: Indicates whether the EmailIdentity has passed Spf verfication.
                              example: true
                              nullable: false
                              readOnly: true
                              type: boolean
                            lastDkimVerifiedOn:
                              description: The date the Dkim settings were last verified.
                              example: 2022-01-31
                              format: date
                              nullable: false
                              readOnly: true
                              type: string
                            lastSpfVerifiedOn:
                              description: The date the Spf settings were last verified.
                              example: 2022-01-31
                              format: date
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 EmailIdentities for an employer
      tags:
        - Email Identities
    post:
      description: |
        __Activity name:__ PostEmailIdentityByEmployerId
            

        Create an EmailIdentity for an employer.
      operationId: PostEmailIdentityByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                dkimTokens:
                  items:
                    description: The Tokens which should be registred
                    example: u6deqmqhlgn3wxslcp4cugcz7ognh4gt
                    type: string
                  nullable: true
                  readOnly: true
                  type: array
                emailIdentity:
                  description: The emailIdentity that can be used when sending email.
                  example: provider.com
                  nullable: false
                  readOnly: false
                  type: string
                emailIdentityType:
                  description: The type of the set emailIdentity
                  enum:
                    - DOMAIN
                  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
                isDkimVerified:
                  description: Indicates whether the EmailIdentity has passed Spf verfication.
                  example: true
                  nullable: false
                  readOnly: true
                  type: boolean
                isSpfVerified:
                  description: Indicates whether the EmailIdentity has passed Spf verfication.
                  example: true
                  nullable: false
                  readOnly: true
                  type: boolean
                lastDkimVerifiedOn:
                  description: The date the Dkim settings were last verified.
                  example: 2022-01-31
                  format: date
                  nullable: false
                  readOnly: true
                  type: string
                lastSpfVerifiedOn:
                  description: The date the Spf settings were last verified.
                  example: 2022-01-31
                  format: date
                  nullable: false
                  readOnly: true
                  type: string
              type: object
        description: EmailIdentity to add to the employer.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          dkimTokens:
                            items:
                              description: The Tokens which should be registred
                              example: u6deqmqhlgn3wxslcp4cugcz7ognh4gt
                              type: string
                            nullable: true
                            readOnly: true
                            type: array
                          emailIdentity:
                            description: The emailIdentity that can be used when sending email.
                            example: provider.com
                            nullable: false
                            readOnly: false
                            type: string
                          emailIdentityType:
                            description: The type of the set emailIdentity
                            enum:
                              - DOMAIN
                            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
                          isDkimVerified:
                            description: Indicates whether the EmailIdentity has passed Spf verfication.
                            example: true
                            nullable: false
                            readOnly: true
                            type: boolean
                          isSpfVerified:
                            description: Indicates whether the EmailIdentity has passed Spf verfication.
                            example: true
                            nullable: false
                            readOnly: true
                            type: boolean
                          lastDkimVerifiedOn:
                            description: The date the Dkim settings were last verified.
                            example: 2022-01-31
                            format: date
                            nullable: false
                            readOnly: true
                            type: string
                          lastSpfVerifiedOn:
                            description: The date the Spf settings were last verified.
                            example: 2022-01-31
                            format: date
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 EmailIdentity for an employer
      tags:
        - Email Identities
  "/providers/employers/{employerId}/emailidentities/verify":
    post:
      description: |
        __Activity name:__ PostVerifyEmailIdentityByEmployerId
            

        Verify an EmailIdentity for an employer. The verficationstatus will we saved and used by Loket when sending email. 
      operationId: PostVerifyEmailIdentityByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                dkimTokens:
                  items:
                    description: The Tokens which should be registred
                    example: u6deqmqhlgn3wxslcp4cugcz7ognh4gt
                    type: string
                  nullable: true
                  readOnly: true
                  type: array
                emailIdentity:
                  description: The emailIdentity that can be used when sending email.
                  example: provider.com
                  nullable: false
                  readOnly: false
                  type: string
                emailIdentityType:
                  description: The type of the set emailIdentity
                  enum:
                    - DOMAIN
                  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
                isDkimVerified:
                  description: Indicates whether the EmailIdentity has passed Spf verfication.
                  example: true
                  nullable: false
                  readOnly: true
                  type: boolean
                isSpfVerified:
                  description: Indicates whether the EmailIdentity has passed Spf verfication.
                  example: true
                  nullable: false
                  readOnly: true
                  type: boolean
                lastDkimVerifiedOn:
                  description: The date the Dkim settings were last verified.
                  example: 2022-01-31
                  format: date
                  nullable: false
                  readOnly: true
                  type: string
                lastSpfVerifiedOn:
                  description: The date the Spf settings were last verified.
                  example: 2022-01-31
                  format: date
                  nullable: false
                  readOnly: true
                  type: string
              type: object
        description: EmailIdentity to Verify.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          dkimTokens:
                            items:
                              description: The Tokens which should be registred
                              example: u6deqmqhlgn3wxslcp4cugcz7ognh4gt
                              type: string
                            nullable: true
                            readOnly: true
                            type: array
                          emailIdentity:
                            description: The emailIdentity that can be used when sending email.
                            example: provider.com
                            nullable: false
                            readOnly: false
                            type: string
                          emailIdentityType:
                            description: The type of the set emailIdentity
                            enum:
                              - DOMAIN
                            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
                          isDkimVerified:
                            description: Indicates whether the EmailIdentity has passed Spf verfication.
                            example: true
                            nullable: false
                            readOnly: true
                            type: boolean
                          isSpfVerified:
                            description: Indicates whether the EmailIdentity has passed Spf verfication.
                            example: true
                            nullable: false
                            readOnly: true
                            type: boolean
                          lastDkimVerifiedOn:
                            description: The date the Dkim settings were last verified.
                            example: 2022-01-31
                            format: date
                            nullable: false
                            readOnly: true
                            type: string
                          lastSpfVerifiedOn:
                            description: The date the Spf settings were last verified.
                            example: 2022-01-31
                            format: date
                            nullable: false
                            readOnly: true
                            type: string
                        type: object
                    type: object
          description: Verified
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Verify an EmailIdentity for an employer
      tags:
        - Email Identities
  "/providers/employers/{employerId}/emailtemplates":
    get:
      description: |
        __Activity name :__ GetEmailTemplatesByEmployerId

        Get a list of the email templates for an employer.

        __Note:__ Email templates can be defined on employer, provider and loket level. This endpoint returns for each emailtype the email template which is currently in use for the employer.
      operationId: GetEmailTemplatesByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            category:
                              description: The module to which the email template belongs
                              nullable: false
                              properties:
                                key:
                                  description: The id of the categorie to which the email template belongs.
                                  example: 3
                                  type: integer
                                value:
                                  description: The name of the categorie to which the email template belongs.
                                  example: Verlof
                                  type: string
                              readOnly: true
                              type: object
                            definedAtLevel:
                              description: The level at which the email template is defined.
                              enum:
                                - employer
                                - provider
                                - loket
                              example: employer
                              nullable: false
                              readOnly: true
                              type: string
                            dependsOnModule:
                              description: The module to which the email template belongs
                              nullable: false
                              properties:
                                description:
                                  description: The name of the module to which the email template belongs.
                                  example: Verlof
                                  type: string
                                id:
                                  description: The id of the module to which the email template belongs.
                                  example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                  format: uuid
                                  type: string
                              readOnly: true
                              type: object
                            email:
                              description: The configurable parts of the email template
                              nullable: false
                              properties:
                                body:
                                  description: The body text of the email.
                                  example: Je verlofaanvraag is behandeld.
                                  maxLength: 6000
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                senderEmail:
                                  description: The email address of the sender.
                                  example: noreply@loket.nl
                                  maxLength: 255
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                subject:
                                  description: The subjectline of the email.
                                  example: Verlofaanvraag behandeld
                                  maxLength: 255
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                              readOnly: false
                              type: object
                            isEmailTemplateEditable:
                              description: Indicates whether the email template can be editted.
                              example: true
                              nullable: false
                              readOnly: true
                              type: boolean
                            type:
                              description: The type of the email template
                              nullable: false
                              properties:
                                description:
                                  description: The description of the type of the email template.
                                  example: Verlofaanvraag behandeld (voor de indiener)
                                  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
                                sortOrder:
                                  description: A number used to sort the list.
                                  example: 210
                                  type: integer
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 email templates for an employer
      tags:
        - Email templates
  "/providers/employers/{employerId}/emailtemplates/{emailTemplateId}":
    delete:
      description: |
        __Activity name :__ DeleteEmailTemplateByEmployerIdAndEmailTemplateId

        Delete an existing email template record
      operationId: DeleteEmailTemplateByEmployerIdAndEmailTemplateId
      parameters:
        - description: The unique identifier of the record
          in: query
          name: emailtemplateId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
        - description: Automatically added
          in: path
          name: employerId
          required: true
          schema:
            type: string
        - description: Automatically added
          in: path
          name: emailTemplateId
          required: true
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 email template record
      tags:
        - Email templates
    get:
      description: |
        __Activity name :__ GetEmailTemplateByEmployerIdAndEmailTemplateId

        Get the details of an email template. The available email template placeholders can be aquired by adding /metadata to the url.
      operationId: GetEmailTemplateByEmployerIdAndEmailTemplateId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of the record
          in: query
          name: emailtemplateId
          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 <TOKEN>
            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: emailTemplateId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            category:
                              description: The module to which the email template belongs
                              nullable: false
                              properties:
                                key:
                                  description: The id of the categorie to which the email template belongs.
                                  example: 3
                                  type: integer
                                value:
                                  description: The name of the categorie to which the email template belongs.
                                  example: Verlof
                                  type: string
                              readOnly: true
                              type: object
                            definedAtLevel:
                              description: The level at which the email template is defined.
                              enum:
                                - employer
                                - provider
                                - loket
                              example: employer
                              nullable: false
                              readOnly: true
                              type: string
                            dependsOnModule:
                              description: The module to which the email template belongs
                              nullable: false
                              properties:
                                description:
                                  description: The name of the module to which the email template belongs.
                                  example: Verlof
                                  type: string
                                id:
                                  description: The id of the module to which the email template belongs.
                                  example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                  format: uuid
                                  type: string
                              readOnly: true
                              type: object
                            email:
                              description: The configurable parts of the email template
                              nullable: false
                              properties:
                                body:
                                  description: The body text of the email.
                                  example: Je verlofaanvraag is behandeld.
                                  maxLength: 6000
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                senderEmail:
                                  description: The email address of the sender.
                                  example: noreply@loket.nl
                                  maxLength: 255
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                subject:
                                  description: The subjectline of the email.
                                  example: Verlofaanvraag behandeld
                                  maxLength: 255
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                              readOnly: false
                              type: object
                            isEmailTemplateEditable:
                              description: Indicates whether the email template can be editted.
                              example: true
                              nullable: false
                              readOnly: true
                              type: boolean
                            type:
                              description: The type of the email template
                              nullable: false
                              properties:
                                description:
                                  description: The description of the type of the email template.
                                  example: Verlofaanvraag behandeld (voor de indiener)
                                  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
                                sortOrder:
                                  description: A number used to sort the list.
                                  example: 210
                                  type: integer
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 email template
      tags:
        - Email templates
    put:
      description: |
        __Activity name :__ PutEmailTemplateByEmployerIdAndEmailTemplateId

        Edit the email template. The subject, body and senderEmail can be editted. 
      operationId: PutEmailTemplateByEmployerIdAndEmailTemplateId
      parameters:
        - description: The unique identifier of the record
          in: query
          name: emailtemplateId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
        - description: Automatically added
          in: path
          name: employerId
          required: true
          schema:
            type: string
        - description: Automatically added
          in: path
          name: emailTemplateId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                category:
                  description: The module to which the email template belongs
                  nullable: false
                  properties:
                    key:
                      description: The id of the categorie to which the email template belongs.
                      example: 3
                      type: integer
                    value:
                      description: The name of the categorie to which the email template belongs.
                      example: Verlof
                      type: string
                  readOnly: true
                  type: object
                definedAtLevel:
                  description: The level at which the email template is defined.
                  enum:
                    - employer
                    - provider
                    - loket
                  example: employer
                  nullable: false
                  readOnly: true
                  type: string
                dependsOnModule:
                  description: The module to which the email template belongs
                  nullable: false
                  properties:
                    description:
                      description: The name of the module to which the email template belongs.
                      example: Verlof
                      type: string
                    id:
                      description: The id of the module to which the email template belongs.
                      example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                      format: uuid
                      type: string
                  readOnly: true
                  type: object
                email:
                  description: The configurable parts of the email template
                  nullable: false
                  properties:
                    body:
                      description: The body text of the email.
                      example: Je verlofaanvraag is behandeld.
                      maxLength: 6000
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    senderEmail:
                      description: The email address of the sender.
                      example: noreply@loket.nl
                      maxLength: 255
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    subject:
                      description: The subjectline of the email.
                      example: Verlofaanvraag behandeld
                      maxLength: 255
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                  readOnly: false
                  type: object
                isEmailTemplateEditable:
                  description: Indicates whether the email template can be editted.
                  example: true
                  nullable: false
                  readOnly: true
                  type: boolean
                type:
                  description: The type of the email template
                  nullable: false
                  properties:
                    description:
                      description: The description of the type of the email template.
                      example: Verlofaanvraag behandeld (voor de indiener)
                      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
                    sortOrder:
                      description: A number used to sort the list.
                      example: 210
                      type: integer
                  readOnly: true
                  type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          category:
                            description: The module to which the email template belongs
                            nullable: false
                            properties:
                              key:
                                description: The id of the categorie to which the email template belongs.
                                example: 3
                                type: integer
                              value:
                                description: The name of the categorie to which the email template belongs.
                                example: Verlof
                                type: string
                            readOnly: true
                            type: object
                          definedAtLevel:
                            description: The level at which the email template is defined.
                            enum:
                              - employer
                              - provider
                              - loket
                            example: employer
                            nullable: false
                            readOnly: true
                            type: string
                          dependsOnModule:
                            description: The module to which the email template belongs
                            nullable: false
                            properties:
                              description:
                                description: The name of the module to which the email template belongs.
                                example: Verlof
                                type: string
                              id:
                                description: The id of the module to which the email template belongs.
                                example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                format: uuid
                                type: string
                            readOnly: true
                            type: object
                          email:
                            description: The configurable parts of the email template
                            nullable: false
                            properties:
                              body:
                                description: The body text of the email.
                                example: Je verlofaanvraag is behandeld.
                                maxLength: 6000
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              senderEmail:
                                description: The email address of the sender.
                                example: noreply@loket.nl
                                maxLength: 255
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              subject:
                                description: The subjectline of the email.
                                example: Verlofaanvraag behandeld
                                maxLength: 255
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                            readOnly: false
                            type: object
                          isEmailTemplateEditable:
                            description: Indicates whether the email template can be editted.
                            example: true
                            nullable: false
                            readOnly: true
                            type: boolean
                          type:
                            description: The type of the email template
                            nullable: false
                            properties:
                              description:
                                description: The description of the type of the email template.
                                example: Verlofaanvraag behandeld (voor de indiener)
                                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
                              sortOrder:
                                description: A number used to sort the list.
                                example: 210
                                type: integer
                            readOnly: true
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit an email template record
      tags:
        - Email templates
  "/providers/employers/{employerId}/employees":
    get:
      description: |
        __Activity name :__ GetEmployeesByEmployerId

        Get a list of all employees for the given employer
      operationId: GetEmployeesByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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

            The default option is `application/json;version=yyyy-MM-dd`. For the export functionality two other options are supporten:
              * text/csv;version=yyyy-MM-dd
              * application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;version=yyyy-MM-dd
          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: |
            Allows the user set what values are returnd in the "export" (csv or excel).
          in: header
          name: X-ReportInput
          required: false
          schema:
            type: string
      responses:
        "200":
          content:
            application/json;version=2018-12-31:
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            address:
                              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
                                furtherIndication:
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      description: The key of the further indication ('nadere aanduiding'). 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 ('nadere aanduiding'), 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, 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: false
                                  readOnly: false
                                  type: string
                              type: object
                            contactInformation:
                              nullable: false
                              properties:
                                emailAddress:
                                  description: The e-mail address of the employee.
                                  example: info@loket.nl
                                  maxLength: 255
                                  nullable: true
                                  pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                  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:
                              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: false
                                      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
                                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
                            employeeNumber:
                              description: |
                                The employee number to uniquely identify an employee within an employer
                              example: 156
                              format: int32
                              minimum: 1
                              nullable: false
                              readOnly: false
                              type: integer
                            exclusionFromAbsenceStatus:
                              description: |
                                Indicates whether the employee is excluded for any information of absence
                              example: false
                              nullable: false
                              readOnly: false
                              type: boolean
                            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
                            identityDocument:
                              nullable: true
                              properties:
                                documentIdentification:
                                  example: CRE45553433
                                  nullable: false
                                  readOnly: false
                                  type: string
                                typeOfDocument:
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      description: The key for the type of document. Posible values can be aquired 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
                              readOnly: false
                              type: object
                            personalDetails:
                              nullable: false
                              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: 2062-08-21
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                civilStatus:
                                  description: |
                                    The civil/marital status of the employee
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Maried
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                dateOfBirth:
                                  description: |
                                    The date of birth
                                  example: 1995-05-21
                                  format: date
                                  nullable: false
                                  readOnly: false
                                  type: string
                                dateOfDeath:
                                  description: |
                                    The date of death
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                firstName:
                                  description: |
                                    The first name, given name, forename or Christian name as part of a persons personal name.
                                  example: Susan
                                  maxLength: 28
                                  minLength: 1
                                  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: false
                                  readOnly: true
                                  type: string
                                gender:
                                  description: |
                                    The gender
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: female
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: false
                                  type: object
                                howToFormatLastName:
                                  description: |
                                    Indicates how the system will format the last name.
                                  format: metadata
                                  nullable: false
                                  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
                                  readOnly: false
                                  type: object
                                initials:
                                  description: |
                                    The initials
                                  example: S.L.
                                  maxLength: 6
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                lastName:
                                  description: |
                                    The last name, family name or surname as part of a persons personal name.
                                  example: Bergen
                                  maxLength: 25
                                  minLength: 1
                                  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:
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      description: The key for the nationality. Posible values can be aquired via the metadata endpoint
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      description: Description of the nationality
                                      example: Dutch
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: false
                                  type: object
                                photo:
                                  description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                  example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                  format: url
                                  nullable: true
                                  readOnly: true
                                  type: string
                                placeOfBirth:
                                  description: |
                                    The place of birth
                                  example: Amsterdam
                                  maxLength: 24
                                  minLength: 1
                                  nullable: true
                                  readOnly: false
                                  type: string
                                prefix:
                                  description: |
                                    The prefix to the last name
                                  example: van
                                  maxLength: 10
                                  minLength: 1
                                  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
                                  readOnly: false
                                  type: object
                              readOnly: false
                              type: object
                            revokeEmployeeSelfServiceAccessOn:
                              description: |
                                The date on which the Employee will be automatically blocked.
                              example: 2018-10-23
                              format: date
                              nullable: true
                              readOnly: true
                              type: string
                            statusEmployeeSelfService:
                              description: The status of the accessability of the Employee Self Service application. In case ESS is not relevant the object will be returned as NULL. Possible values can be acquired via the metadata endpoint
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: Blocked
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            travel:
                              nullable: false
                              properties:
                                travelDistanceToWork:
                                  description: |
                                    The one way distance in metres the employee has to travel to work.
                                  example: 32
                                  format: int32
                                  minimum: 1
                                  nullable: true
                                  readOnly: false
                                  type: integer
                              readOnly: false
                              type: object
                        type: array
                    type: object
            application/json;version=2021-03-29:
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            address:
                              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
                                furtherIndication:
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      description: The key of the further indication ('nadere aanduiding'). 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 ('nadere aanduiding'), 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, 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: false
                                  readOnly: false
                                  type: string
                              type: object
                            contactInformation:
                              nullable: false
                              properties:
                                businessEmailAddress:
                                  description: The business e-mail address of the employee.
                                  example: info@loket.nl
                                  maxLength: 255
                                  nullable: true
                                  pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                  readOnly: false
                                  type: string
                                businessMobilePhoneNumber:
                                  description: The business mobile phone number of the employee.
                                  example: +31 6-1231456
                                  maxLength: 15
                                  nullable: true
                                  readOnly: false
                                  type: string
                                businessPhoneNumber:
                                  description: The business phone number of the employee.
                                  example: +31 13-1234567
                                  maxLength: 15
                                  nullable: true
                                  readOnly: false
                                  type: string
                                emailAddress:
                                  description: The e-mail address of the employee.
                                  example: info@loket.nl
                                  maxLength: 255
                                  nullable: true
                                  pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                  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:
                              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: false
                                      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
                                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
                            employeeNumber:
                              description: |
                                The employee number to uniquely identify an employee within an employer
                              example: 156
                              format: int32
                              minimum: 1
                              nullable: false
                              readOnly: false
                              type: integer
                            exclusionFromAbsenceStatus:
                              description: |
                                Indicates whether the employee is excluded for any information of absence
                              example: false
                              nullable: false
                              readOnly: false
                              type: boolean
                            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
                            identityDocument:
                              nullable: true
                              properties:
                                documentIdentification:
                                  example: CRE45553433
                                  nullable: false
                                  readOnly: false
                                  type: string
                                typeOfDocument:
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      description: The key for the type of document. Posible values can be aquired 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
                              readOnly: false
                              type: object
                            personalDetails:
                              nullable: false
                              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: 2062-08-21
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                civilStatus:
                                  description: |
                                    The civil/marital status of the employee
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Maried
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                dateOfBirth:
                                  description: |
                                    The date of birth
                                  example: 1995-05-21
                                  format: date
                                  nullable: false
                                  readOnly: false
                                  type: string
                                dateOfDeath:
                                  description: |
                                    The date of death
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                firstName:
                                  description: |
                                    The first name, given name, forename or Christian name as part of a persons personal name.
                                  example: Susan
                                  maxLength: 28
                                  minLength: 1
                                  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: false
                                  readOnly: true
                                  type: string
                                gender:
                                  description: |
                                    The gender
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: female
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: false
                                  type: object
                                howToFormatLastName:
                                  description: |
                                    Indicates how the system will format the last name.
                                  format: metadata
                                  nullable: false
                                  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
                                  readOnly: false
                                  type: object
                                initials:
                                  description: |
                                    The initials
                                  example: S.L.
                                  maxLength: 6
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                lastName:
                                  description: |
                                    The last name, family name or surname as part of a persons personal name.
                                  example: Bergen
                                  maxLength: 25
                                  minLength: 1
                                  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:
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      description: The key for the nationality. Posible values can be aquired via the metadata endpoint
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      description: Description of the nationality
                                      example: Dutch
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: false
                                  type: object
                                photo:
                                  description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                  example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                  format: url
                                  nullable: true
                                  readOnly: true
                                  type: string
                                placeOfBirth:
                                  description: |
                                    The place of birth
                                  example: Amsterdam
                                  maxLength: 24
                                  minLength: 1
                                  nullable: true
                                  readOnly: false
                                  type: string
                                prefix:
                                  description: |
                                    The prefix to the last name
                                  example: van
                                  maxLength: 10
                                  minLength: 1
                                  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
                                  readOnly: false
                                  type: object
                              readOnly: false
                              type: object
                            revokeEmployeeSelfServiceAccessOn:
                              description: |
                                The date on which the Employee will be automatically blocked.
                              example: 2018-10-23
                              format: date
                              nullable: true
                              readOnly: true
                              type: string
                            statusEmployeeSelfService:
                              description: The status of the accessability of the Employee Self Service application. In case ESS is not relevant the object will be returned as NULL. Possible values can be acquired via the metadata endpoint
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: Blocked
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            travel:
                              nullable: false
                              properties:
                                travelDistanceToWork:
                                  description: |
                                    The one way distance in metres the employee has to travel to work.
                                  example: 32
                                  format: int32
                                  minimum: 1
                                  nullable: true
                                  readOnly: false
                                  type: integer
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employees for an employer
      tags:
        - Employee
  "/providers/employers/{employerId}/employees/actualpartners":
    get:
      description: |
        __Activity name:__ GetActualPartnersByEmployerId
            

        Get the list of Actual partners for all employees of an employer
      operationId: GetActualPartnersByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: Set a reference date for choosing the date dependent data.
          in: query
          name: referenceDate
          required: false
          schema:
            example: 2022-01-01
            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:
                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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - properties:
                                employmentId:
                                  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
                                partner:
                                  properties:
                                    dateOfBirth:
                                      description: |
                                        The date of birth
                                      example: 1995-05-21
                                      format: date
                                      nullable: false
                                      readOnly: false
                                      type: string
                                    dateOfDeath:
                                      description: |
                                        The date of death
                                      format: date
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    endDate:
                                      description: end date
                                      example: 1995-05-21
                                      format: date
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    firstName:
                                      description: |
                                        The first name, given name, forename or Christian name as part of a persons personal name.
                                      example: Susan
                                      maxLength: 28
                                      minLength: 1
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    gender:
                                      description: |
                                        The gender
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          example: 2
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                        value:
                                          example: female
                                          maxLength: 50
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: false
                                      type: object
                                    howToFormatLastName:
                                      description: |
                                        Indicates how the system will format the last name.
                                      format: metadata
                                      nullable: false
                                      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
                                      readOnly: false
                                      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
                                    initials:
                                      description: |
                                        The initials
                                      example: S.L.
                                      maxLength: 6
                                      minLength: 1
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    lastName:
                                      description: |
                                        The last name, family name or surname as part of a persons personal name.
                                      example: Bergen
                                      maxLength: 25
                                      minLength: 1
                                      nullable: false
                                      readOnly: false
                                      type: string
                                    placeOfBirth:
                                      description: |
                                        The place of birth
                                      example: Amsterdam
                                      maxLength: 24
                                      minLength: 1
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    prefix:
                                      description: |
                                        The prefix to the last name
                                      example: van
                                      maxLength: 10
                                      minLength: 1
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    startDate:
                                      description: startdate
                                      example: 1995-05-21
                                      format: date
                                      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
                                      readOnly: false
                                      type: object
                                    waoClassification:
                                      description: The occupational disability classification in the form of a percentage range.
                                      format: metadata
                                      nullable: true
                                      properties:
                                        key:
                                          description: |
                                            The key of the occupational disability classification. Possible values can be acquired via the metadata endpoint.
                                          example: 2
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                        value:
                                          description: |
                                            Description of the occupational disability classification.
                                          example: 15 - 24
                                          maxLength: 50
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: false
                                      type: object
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 Partners for an employer
      tags:
        - Actuals
  "/providers/employers/{employerId}/employees/children":
    get:
      description: |
        __Activity name:__ GetChildrenByEmployerId
            

        Get the list of Children for all employees of an employer
      operationId: GetChildrenByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: Set a reference date for choosing the date dependent data.
          in: query
          name: referenceDate
          required: false
          schema:
            example: 2022-01-01
            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:
                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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - properties:
                                children:
                                  properties:
                                    dateOfBirth:
                                      description: |
                                        The date of birth
                                      example: 1995-05-21
                                      format: date
                                      nullable: false
                                      readOnly: false
                                      type: string
                                    dateOfDeath:
                                      description: |
                                        The date of death
                                      format: date
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    firstName:
                                      description: |
                                        The first name, given name, forename or Christian name as part of a persons personal name.
                                      example: Susan
                                      maxLength: 28
                                      minLength: 1
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    gender:
                                      description: |
                                        The gender
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          example: 2
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                        value:
                                          example: female
                                          maxLength: 50
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: false
                                      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
                                    initials:
                                      description: |
                                        The initials
                                      example: S.L.
                                      maxLength: 6
                                      minLength: 1
                                      nullable: false
                                      readOnly: false
                                      type: string
                                    lastName:
                                      description: |
                                        The last name, family name or surname as part of a persons personal name.
                                      example: Bergen
                                      maxLength: 25
                                      minLength: 1
                                      nullable: false
                                      readOnly: false
                                      type: string
                                    prefix:
                                      description: |
                                        The prefix to the last name
                                      example: van
                                      maxLength: 10
                                      minLength: 1
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    residenceStatus:
                                      description: |
                                        Indicator to tell if the child is living at home or not. Use null if unknown.
                                      format: metadata
                                      nullable: true
                                      properties:
                                        key:
                                          description: The key for the residence status
                                          example: 2
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                        value:
                                          description: Is the child living with his parent
                                          example: Living at home
                                          maxLength: 50
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: false
                                      type: object
                                  type: object
                                employmentId:
                                  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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 Children for an employer
      tags:
        - Actuals
  "/providers/employers/{employerId}/employees/contacts":
    get:
      description: |
        __Activity name:__ GetContactsByEmployerId
            

        Get the list of Contacts for all employees of an employer
      operationId: GetContactsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: Set a reference date for choosing the date dependent data.
          in: query
          name: referenceDate
          required: false
          schema:
            example: 2022-01-01
            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:
                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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - properties:
                                contacts:
                                  properties:
                                    address:
                                      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
                                        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: 1234 AA
                                          maxLength: 9
                                          nullable: true
                                          readOnly: false
                                          type: string
                                        street:
                                          description: Streetname of the address
                                          example: Voordijk
                                          maxLength: 24
                                          nullable: false
                                          readOnly: false
                                          type: string
                                      type: object
                                    description:
                                      description: Describes the relationship of the contact to the employee
                                      example: Moeder
                                      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
                                    name:
                                      description: Name of the contact
                                      example: Johanna Bakker
                                      maxLength: 70
                                      nullable: false
                                      readOnly: false
                                      type: string
                                    particularities:
                                      description: Extra information about the contact
                                      example: Genoemd adres is een priveadres
                                      maxLength: 4000
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    phoneNumber:
                                      description: The phone number of the contact
                                      example: 013-12345678
                                      maxLength: 15
                                      nullable: true
                                      readOnly: false
                                      type: string
                                  type: object
                                employmentId:
                                  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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 Contacts for an employer
      tags:
        - Actuals
  "/providers/employers/{employerId}/employees/employments":
    get:
      description: |
        __Activity name :__ GetEmploymentsByEmployerId

        Get a list of employments for an employer

        This endpoint only returns the employments that meet the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
      operationId: GetEmploymentsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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=2019-12-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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - properties:
                                employee:
                                  format: metadata
                                  nullable: false
                                  properties:
                                    dateOfBirth:
                                      description: |
                                        The date of birth
                                      example: 1995-05-21
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    employeeNumber:
                                      description: The employee number to uniquely identify a employee within a 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
                                    lastNamePartner:
                                      description: The last name of the partner of the employee
                                      example: Wiel
                                      maxLength: 25
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    photo:
                                      description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                      example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                      format: url
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    prefix:
                                      description: The prefix of the employee
                                      example: van
                                      maxLength: 10
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    prefixPartner:
                                      description: The prefix of the partner of the employee
                                      example: van de
                                      maxLength: 10
                                      nullable: true
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                              type: object
                            - properties:
                                calculateWorkingHours:
                                  description: |
                                    Automatically calculate working hours for the employment if the option automatically calculate hours is selected for a given period. NL: Completeren/Berekenen uren
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                cancellationNoticeDate:
                                  description: "The date on which the notice was given by either the employee or the employer. NL: DatumOpzegging"
                                  example: 2018-05-31
                                  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. NL: OpzegtermijnWerknemer"
                                  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. NL: OpzegtermijnWerkgever"
                                  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. NL: PeriodeOpzegTermijn"
                                  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. NL: AanstellingTot"
                                  example: 2019-01-01
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate1:
                                  description: "Until date for commision #1. NL: AanstellingTot1"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate2:
                                  description: "Until date for commision #2. NL: AanstellingTot2"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate3:
                                  description: "Until date for commision #3. NL: AanstellingTot3"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate4:
                                  description: "Until date for commision #4. NL: AanstellingTot4"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate5:
                                  description: "Until date for commision #5. NL: AanstellingTot5"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate6:
                                  description: "Until date for commision #6. NL: AanstellingTot6"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                deviatingCLAExternalParty:
                                  description: "CLA (CAO) code in case of a deviating CLA for external parties . NL: CaoKlantgroepAfwijkend"
                                  example: 2
                                  format: int32
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                deviatingCLATaxReturn:
                                  description: "CLA (CAO) code in case of a deviating CLA for tax returns. NL: CAOUWV"
                                  example: 2
                                  format: int32
                                  maximum: 9999
                                  minimum: 1
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                emailLeaveRequest:
                                  description: "Recipient e-mail adress for notification in case of leave requests. NL: EmailVerlofaanvraag"
                                  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. NL: WerknemerProfielID

                                    `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
                                employmentCategoryType:
                                  description: "A selection of special pre defined employment-types for the employment.  NL: Type dienstverband"
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    value:
                                      example: Ouderschapsverlof
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                employmentContractType:
                                  description: "The type of employment applicable for the employment. NL: BasisDienstverband"
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Arbeidsovereenkomst (excl BBL)
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                employmentDurationType:
                                  description: "A selection of pre defined durations for the employment. NL: SoortDienstverband"
                                  format: metadata
                                  nullable: false
                                  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
                                endDate:
                                  description: "The date on which the employment ends. NL: DatumUitDienst"
                                  example: 2018-10-23
                                  format: date
                                  nullable: true
                                  readOnly: true
                                  type: string
                                endOfEmploymentDueToIllness:
                                  description: "Indicates whether the reason for the termination of an employment is due to long-term illness. NL: ZiekUitDienst"
                                  example: false
                                  nullable: true
                                  readOnly: true
                                  type: boolean
                                endOfEmploymentReason:
                                  description: |-
                                    The reason for the end of the employment. NL: RedenEindeDienstverband

                                    __Note:__ as of 2020-01-01 `endOfEmploymentReasonTaxAuthorities` replaces this field as the main reason for the end of the employment. We say 'main reason' as in certain cases this field still has a purpose. 
                                    Please set this field to 8 (Others) unless one of the following integrations is used for this employment
                                      * UPA-pensioenaangifte
                                      * Cordares
                                      * APG-pensioenaangifte
                                      * Achmea
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      description: The key for the reason for the end of the employment.
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      description: The description of the reason for the end of the employment.
                                      example: VUT
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                endOfEmploymentReasonTaxAuthorities:
                                  description: |-
                                    The reason for the end of the employment as specified by the Dutch Tax authorties. NL: RedenEindeDienstverbandAangifte

                                    __Note:__ This field replaces `endOfEmploymentReason` as of 2020-01-01. `endOfEmploymentReason` will remain as a field in the resource as several integration require this field still.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      description: The key for the reason for the end of the employment.
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      description: The description of the reason for the end of the employment.
                                      example: Beëindiging arbeidsovereenkomst met wederzijds goedvinden op initiatief van de werkgever.
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                essMutationSet:
                                  description: |-
                                    References to a specified set of payrollcomponents that are to accessible via ESS for employee mutations. Standard-set means the standard set defined for the administration will be applied for this employment. NULL means no set will be defined for this employment (so no access to any components). NL : ExportsetID

                                    `essMutationSet` is a metadata field within the werkgever/provider context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: false
                                  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). NL: CodeUitzondering"
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 0
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Geen uitzondering.
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                exemptionPremiumWaiverMarginalLabour:
                                  description: "Indicates whether an exemption (i.e. waiver) on the premium marginal labour (vrijstelling marginale arbeid) applies for this employment. NL: PremieVrijstellingMarginaleArbeid"
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                exemptionWorkRelatedExpenseScheme:
                                  description: "Indicates whether an exemption (i.e. non-participation) on the work-related expense scheme (werkkostenregeling) applies for this employment. NL: WerkkostenRegelingUitsluiting"
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                firstDayNotification:
                                  description: "Indicates whether a first-day notification (EersteDagsMelding) was created for the employment. Attention: this indication cannot be altered after an employment has been created. NL: EersteDagsMelding "
                                  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. NL: SoortOproepkrachtOfInvalkracht
                                  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. NL: HistorischeDatumInDienst"
                                  example: 2012-05-01
                                  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
                                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. NL: NummerInkomstenVerhouding"
                                  example: 12
                                  format: int32
                                  maximum: 9999
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                isAnonymousEmployee:
                                  description: |
                                    An employee that wants to remain anonymous related to social security instances. NL: IsAnoniemeWerknemer
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                isDirectorAndMajorShareholder:
                                  description: "Indicates whether the employment can be classified as a director and major shareholder (Dutch: directeur-grootaandeelhouder or DGA). This field can be `null` in cases where it is unknown whether the employment can be classified as a director and major shareholder. NL: IsDirecteurGrootAandeelhouder"
                                  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. NL: IsFamilieVanEigenaar"
                                  example: false
                                  nullable: true
                                  readOnly: false
                                  type: boolean
                                isGemoedsbezwaardEmployeeInsurance:
                                  description: |
                                    Gemoedsbezwaard Werknemerverzekering. NL: IsGemoedsbezwaardWerknemerverzekering
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                isGemoedsbezwaardNationalInsurance:
                                  description: |
                                    Gemoedsbezwaard Volksverzekering. NL: IsGemoedsbezwaardVolksverzekering
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                isOnCallEmployment:
                                  description: |
                                    Indicates whether the employment is an on-call employment. This field can be `null` in cases where it is unknown whether the employment is an on-call employment. NL: IsOproepkrachtOfInvalkracht
                                  example: true
                                  nullable: false
                                  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. NL: IsVorigeEigenaar"
                                  example: false
                                  nullable: true
                                  readOnly: false
                                  type: boolean
                                linkedEmployment:
                                  description: The unique identifier of an object (GUID/UUID)
                                  example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                  format: uuid
                                  nullable: true
                                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                  readOnly: true
                                  type: string
                                namePayslip:
                                  description: "Name that is visible on payslips for the employment. NL: NaamLoonstrook"
                                  example: Steve Jobs
                                  maxLength: 34
                                  nullable: true
                                  readOnly: false
                                  type: string
                                nonPayrollAdministration:
                                  description: |-
                                    Id of the non-payroll administration. This field cannot simultaneously have a value with payrollAdministration (only one can have a value at a time)

                                    `nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                                  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: true
                                      type: string
                                    name:
                                      description: Name of the non payroll administration
                                      example: HR only employees
                                      maxLength: 70
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                participation55plusRegulationUWV:
                                  description: "Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment. NL: Deelname55Plus"
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                payrollAdministration:
                                  description: |-
                                    Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time)

                                    `payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                                  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: true
                                      type: string
                                    name:
                                      description: Name of the payroll administration
                                      example: ABC accountants
                                      maxLength: 70
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                payrollId:
                                  description: "The payrolling number for this employment of the employee. Used by the payroll engine. This number is automatically generated and cannot be changed by the user. NL: PersoneelsnummerVerloning"
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                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’. NL: PeriodeSalarisPeriodiek"
                                  example: 2
                                  format: int32
                                  maximum: 52
                                  minimum: 1
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                professionCode:
                                  description: "A code field for a profession. This field only applies in case of a specific CLA (Bouw / Infra). Please leave empty if not applicable. NL: BeroepUWV"
                                  example: 4
                                  format: int32
                                  maximum: 999
                                  minimum: 1
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                sendToExternalParty:
                                  description: "Indicates whether payroll information of this employment is sent to external pension funds. Attention: this indication ONLY applies regarding the information to pension funds. If NULL then setting according to regulation is leading. NL: AanleveringExternePartij"
                                  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
                                signalPayGradeAdjustment:
                                  description: "Indicates whether signaling regarding salary scale adjustments are enabled for the employment. NL: SalarisschaalSignaleren"
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                specialIncomeRatio:
                                  description: "Indicates the special income ratio. NL: SpecialeInkomstenVerhouding"
                                  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. NL: AanvangOpzegtermijn"
                                  example: 2018-06-01
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                startDate:
                                  description: "The date on which this employment starts. NL: DatumInDienst"
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                startDateContractOfIndefiniteDuration:
                                  description: "When did the value of `employmentDurationType` change for definite to indefinite. NL: Startdatum onbepaalde tijd This value should be te samen as the `startDate` if the contract was indefinite from the start."
                                  example: 2018-05-08
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                temporaryTaxExemption:
                                  description: "Indicates whether there a temporary tax exemption is to be applied for the employment. NL: TijdelijkeHeffingskorting"
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Nee.
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                typeOfEmployee:
                                  description: "A selection of pre defined employee-types for the employment. NL: SoortWerknemer"
                                  format: metadata
                                  nullable: false
                                  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 (product required). NL: AardDeelnemerschap"
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 0
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: n.vt.
                                      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. NL: Vakantiebonnen"
                                  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 (product required). NL: WaardeDeelnemerschap"
                                  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
                                wachtgeldOldRegulation:
                                  description: "Indicates whether the (old) wachtgeld regulation is applicable for the employment. NL: WachtgeldOudeRegeling"
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                writtenEmploymentContract:
                                  description: "Did the employment and employer make a written contract? NL: Schriftelijke overeenkomst"
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employments for an employer
      tags:
        - Employment
  "/providers/employers/{employerId}/employees/employments/WageProposals":
    get:
      description: |
        __Activity name :__ GetWageProposalsByEmployerId

        Returns a list of wage proposals for the employments of the employer.
        A wage proposal is created when an employment reaches the criteria set for the next tier of wage. 
        E.G the minimum wage is linked to the age of a person so a wage proposal is created 60 days befor the birthday of an employment linked to the minimum wage and configured for wage proposals.
        Via this functionality the created wage proposal can be approved or rejected resulting in either a new wage record updated to reflect the correct wage or in case of a rejection the employment is disabled for wage proposals.
      operationId: GetWageProposalsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            currentGrossWage:
                              description: |
                                The gross wage for the employee
                              example: 23
                              format: double
                              maximum: 1000000
                              minimum: 1
                              nullable: true
                              readOnly: false
                              type: number
                            currentPayGrade:
                              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. 

                                `payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                              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
                            employmentInformation:
                              properties:
                                department:
                                  description: |-
                                    The department of the employment.

                                    `department` is a metadata field within the employer context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: false
                                  properties:
                                    code:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    description:
                                      example: Verkoop
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      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
                                employeeNumber:
                                  description: |
                                    The employee number to uniquely identify an employee within an employer
                                  example: 156
                                  format: int32
                                  minimum: 1
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                firstName:
                                  description: |
                                    The first name, given name, forename or Christian name as part of a persons personal name.
                                  example: Susan
                                  maxLength: 28
                                  minLength: 1
                                  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
                                function:
                                  description: |-
                                    The function of the employment.

                                    `function` is a metadata field within the employer context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: false
                                  properties:
                                    description:
                                      example: Directeur
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    group:
                                      example: internal
                                      maxLength: 5
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    key:
                                      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
                                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
                                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: false
                                  readOnly: true
                                  type: integer
                                payrollAdministration:
                                  description: |-
                                    Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time)

                                    `payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                                  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: true
                                      type: string
                                    name:
                                      description: Name of the payroll administration
                                      example: ABC accountants
                                      maxLength: 70
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                photo:
                                  description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                  example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                  format: url
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            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.
                              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
                            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
                            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.

                                `payScale` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                              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
                            proposalReason:
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  description: The key of the reason
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: The description of the reasson for the proposal
                                  example: Birthday
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            proposedGrossWage:
                              description: |
                                The gross wage for the employee
                              example: 23
                              format: double
                              maximum: 1000000
                              minimum: 1
                              nullable: true
                              readOnly: false
                              type: number
                            proposedPayGrade:
                              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. 

                                `payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                              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
                            startDateProposal:
                              description: The date to which the declaration is applicable. As requested by the employee.
                              example: 2017-11-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            status:
                              description: |-
                                The current status of the wage proposal

                                The status is changed by using the PATCH endpoint.

                                1. Voorgesteld --> Accept or reject
                                2. Goedgekeurd ---> No changes possible
                                3. Afgekeurd ---> No changes possible
                                5. Niet verwerkbaar ---> No changes possible
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Open
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 proposals for the employments of an employer
      tags:
        - Wage proposal
  "/providers/employers/{employerId}/employees/employments/actualbenefitsanddeductions":
    get:
      description: |
        __Activity name:__ GetActualBenefitsAndDeductionsByEmployerId
            

        Get the list of actual benefitsanddeductions for an employer
      operationId: GetActualBenefitsAndDeductionsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: Set a reference date for choosing the date dependent data.
          in: query
          name: referenceDate
          required: false
          schema:
            example: 2022-01-01
            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:
                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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - properties:
                                benefitsAndDeductions:
                                  properties:
                                    endDate:
                                      description: |
                                        The end date for the information in the record.
                                      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
                                    payrollComponent:
                                      description: |
                                        A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                                        `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        category:
                                          description: |
                                            The category of the payroll component. There are six viable categories for this resource: <br/> 7,  Bruto vergoeding volgens tabel<br/> 9,  Netto vergoeding<br/> 30, Bedrag per eenheid<br/> 12, Bruto inhouding<br/> 13, Netto inhouding<br/> 11, Fiscale bijtelling <br/> 17, Afdrachtvermindering<br/>
                                          format: metadata
                                          nullable: false
                                          properties:
                                            key:
                                              example: 1
                                              format: int32
                                              nullable: false
                                              readOnly: true
                                              type: integer
                                            value:
                                              example: Uren
                                              nullable: false
                                              readOnly: true
                                              type: string
                                          readOnly: true
                                          type: object
                                        deductionOrPayment:
                                          description: |
                                            Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
                                          format: metadata
                                          nullable: true
                                          properties:
                                            key:
                                              example: 2
                                              format: int32
                                              nullable: false
                                              readOnly: true
                                              type: integer
                                            value:
                                              example: Betaling
                                              nullable: false
                                              readOnly: true
                                              type: string
                                          readOnly: true
                                          type: object
                                        description:
                                          description: |
                                            The description of the payroll component
                                          example: Uren gewerkt
                                          maxLength: 14
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        key:
                                          description: |
                                            The number for the payroll component.
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                      readOnly: true
                                      type: object
                                    startDate:
                                      description: |
                                        The start date for the information in the record.

                                        A (linked chain)[./#section/Data/Date-chains] per payroll component is maintained within this resource.
                                      example: 1995-05-21
                                      format: date
                                      nullable: false
                                      readOnly: false
                                      type: string
                                    value:
                                      description: |
                                        The value for the selected payroll component.    <br/>
                                      example: 50.87
                                      maximum: 99999.99
                                      minimum: 0.01
                                      nullable: false
                                      readOnly: false
                                      type: number
                                employmentId:
                                  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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 actual benefitsanddeductions for an employer
      tags:
        - Actuals
  "/providers/employers/{employerId}/employees/employments/benefitsanddeductions":
    post:
      description: |
        __Activity name :__ PostCollectiveBenefitsAndDeductionsByEmployerId

        Create new benefits and deduction records for multiple employments of an employer
      operationId: PostCollectiveBenefitsAndDeductionsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                employmentId:
                  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
                payrollComponent:
                  description: |
                    A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment.

                    `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      description: |
                        The number for the payroll component.
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                  readOnly: false
                  type: object
                startDate:
                  description: |
                    The start date for the information in the record.

                    A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                    __Note__ It is posible to have no wage record.
                  example: 1995-05-21
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
                value:
                  description: |
                    The value for the component
                  example: 80
                  format: double
                  maximum: 99999.99
                  minimum: 0.01
                  nullable: true
                  readOnly: false
                  type: number
        description: BenefitsAndDeductions to add.
        required: true
      responses:
        "202":
          description: Accepted
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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 benefits and deductions for multiple employments
      tags:
        - Collective benefits and deductions
  "/providers/employers/{employerId}/employees/employments/calendar/absences":
    get:
      description: |
        __Activity name :__ GetCalendarAbsencesByEmployerId

        For a calendar, this endpoint return the absence calendar items PER specific employment.

        This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
      operationId: GetCalendarAbsencesByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: A valid date (yyyy-MM-dd). First day of the timebox for which calendar data will be collected.
          in: query
          name: startDate
          required: true
          schema:
            format: date
            type: string
        - description: A valid date (yyyy-MM-dd). Last day of the timebox for which calendar data will be collected.
          in: query
          name: endDate
          required: true
          schema:
            format: date
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            calendar:
                              description: |
                                A list of time periods for which absence information is available.
                              items:
                                nullable: true
                                properties:
                                  details:
                                    description: |
                                      In the future this object describes the calendar item in more detail. For now this object will always be NULL.
                                    nullable: true
                                    readOnly: true
                                    type: object
                                  endDate:
                                    description: |
                                      The last day of the period for which absence information is available.
                                    example: 2019-01-05
                                    format: date
                                    nullable: true
                                    readOnly: true
                                    type: string
                                  startDate:
                                    description: |
                                      The first day of the period for which absence information is available.
                                    example: 2019-01-01
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              nullable: false
                              type: array
                            department:
                              description: |-
                                The department of the employment.
                                `department` is a metadata field within the employer context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                code:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                description:
                                  example: Verkoop
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  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
                            employee:
                              nullable: false
                              properties:
                                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
                              readOnly: true
                              type: object
                            employment:
                              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
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 absences per employment (for calendar)
      tags:
        - Calendar
  "/providers/employers/{employerId}/employees/employments/calendar/availablehours":
    get:
      description: |
        __Activity name :__ GetCalendarAvailableHoursByEmployerId

        For a calendar, this endpoint returns the availability of an employment expressed as a pattern for both odd and even weeks. Note that multiple patterns can be active in the time period that is requested using the query parameter `startDate` and `endDate`. While multiple patterns can be returned, on any date only one pattern is active. The patterns do not overlap.

        The available hours for a day are determined by the bi-weekly work pattern (as defined in the Working Hours resource) if such a work pattern is present for the employment. If no bi-weekly work pattern is present and the employment is NOT an on-call employment than the number of standard hours (either shiftHours or deviatingHoursPerWeek) is equally divided over the working days within each week (Monday through Friday).

        This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
      operationId: GetCalendarAvailableHoursByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: A valid date (yyyy-MM-dd). First day of the timebox for which calendar data will be collected.
          in: query
          name: startDate
          required: true
          schema:
            format: date
            type: string
        - description: A valid date (yyyy-MM-dd). Last day of the timebox for which calendar data will be collected.
          in: query
          name: endDate
          required: true
          schema:
            format: date
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            calendar:
                              description: |
                                A list of time periods for which availability information is available.
                              items:
                                properties:
                                  details:
                                    description: |
                                      In the future this object describes the calendar item in more detail. For now this object will always be NULL.
                                    nullable: true
                                    readOnly: true
                                    type: object
                                  endDate:
                                    description: |
                                      The last day of the period for which availability information is available.
                                    example: 2019-01-05
                                    format: date
                                    nullable: true
                                    readOnly: true
                                    type: string
                                  startDate:
                                    description: |
                                      The first day of the period for which availability information is available.
                                    example: 2019-01-01
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              nullable: false
                              type: array
                            department:
                              description: |-
                                The department of the employment.
                                `department` is a metadata field within the employer context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                code:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                description:
                                  example: Verkoop
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  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
                            employee:
                              nullable: false
                              properties:
                                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
                              readOnly: true
                              type: object
                            employment:
                              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
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 available hours per employment (for calendar)
      tags:
        - Calendar
  "/providers/employers/{employerId}/employees/employments/calendar/leave":
    get:
      description: |
        __Activity name :__ GetCalendarLeaveByEmployerId

        This endpoint return the leave calendar items for each employment. Please note: this endpoint only will return calendar items based on leave of the type 'opname'.

        This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
      operationId: GetCalendarLeaveByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: A valid date (yyyy-MM-dd). First day of the timebox for which calendar data will be collected.
          in: query
          name: startDate
          required: true
          schema:
            format: date
            type: string
        - description: A valid date (yyyy-MM-dd). Last day of the timebox for which calendar data will be collected.
          in: query
          name: endDate
          required: true
          schema:
            format: date
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            calendar:
                              description: |
                                A list of time periods for which leave information is available.
                              items:
                                properties:
                                  details:
                                    description: |
                                      In the future this object describes the calendar item in more detail. For now this object will always be NULL.
                                    nullable: true
                                    readOnly: true
                                    type: object
                                  endDate:
                                    description: |
                                      The last day of the period for which leave information is available.
                                    example: 2019-01-05
                                    format: date
                                    nullable: true
                                    readOnly: true
                                    type: string
                                  startDate:
                                    description: |
                                      The first day of the period for which leave information is available.
                                    example: 2019-01-01
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              nullable: false
                              type: array
                            department:
                              description: |-
                                The department of the employment.
                                `department` is a metadata field within the employer context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                code:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                description:
                                  example: Verkoop
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  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
                            employee:
                              nullable: false
                              properties:
                                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
                              readOnly: true
                              type: object
                            employment:
                              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
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 leave per employment (for calendar)
      tags:
        - Calendar
  "/providers/employers/{employerId}/employees/employments/calendar/leaverequests":
    get:
      description: |
        __Activity name :__ GetCalendarLeaveRequestsByEmployerId

        For a calendar, this endpoint return the leave requests calendar items PER specific employment.

        Please note: this endpoint only will return calendar items based on leave request with status 'ingediend'.

        This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
      operationId: GetCalendarLeaveRequestsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: A valid date (yyyy-MM-dd). First day of the timebox for which calendar data will be collected.
          in: query
          name: startDate
          required: true
          schema:
            format: date
            type: string
        - description: A valid date (yyyy-MM-dd). Last day of the timebox for which calendar data will be collected.
          in: query
          name: endDate
          required: true
          schema:
            format: date
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            calendar:
                              description: |
                                A list of time periods for which leave request information is available.
                              items:
                                properties:
                                  details:
                                    description: |
                                      In the future this object describes the calendar item in more detail. For now this object will always be NULL.
                                    nullable: true
                                    readOnly: true
                                    type: object
                                  endDate:
                                    description: |
                                      The last day of the period for which leave request information is available.
                                    example: 2019-01-05
                                    format: date
                                    nullable: true
                                    readOnly: true
                                    type: string
                                  startDate:
                                    description: |
                                      The first day of the period for which leave request information is available.
                                    example: 2019-01-01
                                    format: date
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              nullable: false
                              type: array
                            department:
                              description: |-
                                The department of the employment.
                                `department` is a metadata field within the employer context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                code:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                description:
                                  example: Verkoop
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  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
                            employee:
                              nullable: false
                              properties:
                                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
                              readOnly: true
                              type: object
                            employment:
                              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
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 leave requests per employment (for calendar)
      tags:
        - Calendar
  "/providers/employers/{employerId}/employees/employments/comprehensive":
    get:
      description: |
        __Activity name :__ GetEmploymentsComprehensiveByEmployerId

        Get a list of employments for an employer.  With this version we introduced the "Comprehensive" resource which contains additional entities. 

        This endpoint only returns the employments that meet the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
      operationId: GetEmploymentsComprehensiveByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: Set a reference date for choosing the date dependent data.
          in: query
          name: referenceDate
          required: false
          schema:
            example: 2022-01-01
            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=2019-12-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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - properties:
                                employee:
                                  properties:
                                    address:
                                      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
                                        furtherIndication:
                                          format: metadata
                                          nullable: true
                                          properties:
                                            key:
                                              description: The key of the further indication ('nadere aanduiding'). 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 ('nadere aanduiding'), 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, 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: false
                                          readOnly: false
                                          type: string
                                      type: object
                                    contactInformation:
                                      nullable: false
                                      properties:
                                        businessEmailAddress:
                                          description: The business e-mail address of the employee.
                                          example: info@loket.nl
                                          maxLength: 255
                                          nullable: true
                                          pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                          readOnly: false
                                          type: string
                                        businessMobilePhoneNumber:
                                          description: The business mobile phone number of the employee.
                                          example: +31 6-1231456
                                          maxLength: 15
                                          nullable: true
                                          readOnly: false
                                          type: string
                                        businessPhoneNumber:
                                          description: The business phone number of the employee.
                                          example: +31 13-1234567
                                          maxLength: 15
                                          nullable: true
                                          readOnly: false
                                          type: string
                                        emailAddress:
                                          description: The e-mail address of the employee.
                                          example: info@loket.nl
                                          maxLength: 255
                                          nullable: true
                                          pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                          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:
                                      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: false
                                              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
                                        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
                                    employeeNumber:
                                      description: |
                                        The employee number to uniquely identify an employee within an employer
                                      example: 156
                                      format: int32
                                      minimum: 1
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    exclusionFromAbsenceStatus:
                                      description: |
                                        Indicates whether the employee is excluded for any information of absence
                                      example: false
                                      nullable: false
                                      readOnly: false
                                      type: boolean
                                    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
                                    identityDocument:
                                      nullable: true
                                      properties:
                                        documentIdentification:
                                          example: CRE45553433
                                          nullable: false
                                          readOnly: false
                                          type: string
                                        typeOfDocument:
                                          format: metadata
                                          nullable: false
                                          properties:
                                            key:
                                              description: The key for the type of document. Posible values can be aquired 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
                                      readOnly: false
                                      type: object
                                    personalDetails:
                                      nullable: false
                                      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: 2062-08-21
                                          format: date
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        civilStatus:
                                          description: |
                                            The civil/marital status of the employee
                                          format: metadata
                                          nullable: true
                                          properties:
                                            key:
                                              example: 2
                                              format: int32
                                              nullable: false
                                              readOnly: false
                                              type: integer
                                            value:
                                              example: Maried
                                              maxLength: 50
                                              nullable: false
                                              readOnly: true
                                              type: string
                                          type: object
                                        dateOfBirth:
                                          description: |
                                            The date of birth
                                          example: 1995-05-21
                                          format: date
                                          nullable: false
                                          readOnly: false
                                          type: string
                                        dateOfDeath:
                                          description: |
                                            The date of death
                                          format: date
                                          nullable: true
                                          readOnly: false
                                          type: string
                                        firstName:
                                          description: |
                                            The first name, given name, forename or Christian name as part of a persons personal name.
                                          example: Susan
                                          maxLength: 28
                                          minLength: 1
                                          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: false
                                          readOnly: true
                                          type: string
                                        gender:
                                          description: |
                                            The gender
                                          format: metadata
                                          nullable: false
                                          properties:
                                            key:
                                              example: 2
                                              format: int32
                                              nullable: false
                                              readOnly: false
                                              type: integer
                                            value:
                                              example: female
                                              maxLength: 50
                                              nullable: false
                                              readOnly: true
                                              type: string
                                          readOnly: false
                                          type: object
                                        howToFormatLastName:
                                          description: |
                                            Indicates how the system will format the last name.
                                          format: metadata
                                          nullable: false
                                          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
                                          readOnly: false
                                          type: object
                                        initials:
                                          description: |
                                            The initials
                                          example: S.L.
                                          maxLength: 6
                                          minLength: 1
                                          nullable: false
                                          readOnly: false
                                          type: string
                                        lastName:
                                          description: |
                                            The last name, family name or surname as part of a persons personal name.
                                          example: Bergen
                                          maxLength: 25
                                          minLength: 1
                                          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:
                                          format: metadata
                                          nullable: true
                                          properties:
                                            key:
                                              description: The key for the nationality. Posible values can be aquired via the metadata endpoint
                                              example: 2
                                              format: int32
                                              nullable: false
                                              readOnly: false
                                              type: integer
                                            value:
                                              description: Description of the nationality
                                              example: Dutch
                                              maxLength: 50
                                              nullable: false
                                              readOnly: true
                                              type: string
                                          readOnly: false
                                          type: object
                                        photo:
                                          description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                          example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                          format: url
                                          nullable: true
                                          readOnly: true
                                          type: string
                                        placeOfBirth:
                                          description: |
                                            The place of birth
                                          example: Amsterdam
                                          maxLength: 24
                                          minLength: 1
                                          nullable: true
                                          readOnly: false
                                          type: string
                                        prefix:
                                          description: |
                                            The prefix to the last name
                                          example: van
                                          maxLength: 10
                                          minLength: 1
                                          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
                                          readOnly: false
                                          type: object
                                      readOnly: false
                                      type: object
                                    revokeEmployeeSelfServiceAccessOn:
                                      description: |
                                        The date on which the Employee will be automatically blocked.
                                      example: 2018-10-23
                                      format: date
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    statusEmployeeSelfService:
                                      description: The status of the accessability of the Employee Self Service application. In case ESS is not relevant the object will be returned as NULL. Possible values can be acquired via the metadata endpoint
                                      format: metadata
                                      nullable: true
                                      properties:
                                        key:
                                          example: 2
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        value:
                                          example: Blocked
                                          maxLength: 50
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    travel:
                                      nullable: false
                                      properties:
                                        travelDistanceToWork:
                                          description: |
                                            The one way distance in metres the employee has to travel to work.
                                          example: 32
                                          format: int32
                                          minimum: 1
                                          nullable: true
                                          readOnly: false
                                          type: integer
                                      readOnly: false
                                      type: object
                              type: object
                            - properties:
                                calculateWorkingHours:
                                  description: |
                                    Automatically calculate working hours for the employment if the option automatically calculate hours is selected for a given period. NL: Completeren/Berekenen uren
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                cancellationNoticeDate:
                                  description: "The date on which the notice was given by either the employee or the employer. NL: DatumOpzegging"
                                  example: 2018-05-31
                                  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. NL: OpzegtermijnWerknemer"
                                  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. NL: OpzegtermijnWerkgever"
                                  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. NL: PeriodeOpzegTermijn"
                                  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. NL: AanstellingTot"
                                  example: 2019-01-01
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate1:
                                  description: "Until date for commision #1. NL: AanstellingTot1"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate2:
                                  description: "Until date for commision #2. NL: AanstellingTot2"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate3:
                                  description: "Until date for commision #3. NL: AanstellingTot3"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate4:
                                  description: "Until date for commision #4. NL: AanstellingTot4"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate5:
                                  description: "Until date for commision #5. NL: AanstellingTot5"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                commissionUntilDate6:
                                  description: "Until date for commision #6. NL: AanstellingTot6"
                                  example: 2018-05-31
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                deviatingCLAExternalParty:
                                  description: "CLA (CAO) code in case of a deviating CLA for external parties . NL: CaoKlantgroepAfwijkend"
                                  example: 2
                                  format: int32
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                deviatingCLATaxReturn:
                                  description: "CLA (CAO) code in case of a deviating CLA for tax returns. NL: CAOUWV"
                                  example: 2
                                  format: int32
                                  maximum: 9999
                                  minimum: 1
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                emailLeaveRequest:
                                  description: "Recipient e-mail adress for notification in case of leave requests. NL: EmailVerlofaanvraag"
                                  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. NL: WerknemerProfielID

                                    `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
                                employmentCategoryType:
                                  description: "A selection of special pre defined employment-types for the employment.  NL: Type dienstverband"
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    value:
                                      example: Ouderschapsverlof
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                employmentContractType:
                                  description: "The type of employment applicable for the employment. NL: BasisDienstverband"
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Arbeidsovereenkomst (excl BBL)
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                employmentDurationType:
                                  description: "A selection of pre defined durations for the employment. NL: SoortDienstverband"
                                  format: metadata
                                  nullable: false
                                  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
                                endDate:
                                  description: "The date on which the employment ends. NL: DatumUitDienst"
                                  example: 2018-10-23
                                  format: date
                                  nullable: true
                                  readOnly: true
                                  type: string
                                endOfEmploymentDueToIllness:
                                  description: "Indicates whether the reason for the termination of an employment is due to long-term illness. NL: ZiekUitDienst"
                                  example: false
                                  nullable: true
                                  readOnly: true
                                  type: boolean
                                endOfEmploymentReason:
                                  description: |-
                                    The reason for the end of the employment. NL: RedenEindeDienstverband

                                    __Note:__ as of 2020-01-01 `endOfEmploymentReasonTaxAuthorities` replaces this field as the main reason for the end of the employment. We say 'main reason' as in certain cases this field still has a purpose. 
                                    Please set this field to 8 (Others) unless one of the following integrations is used for this employment
                                      * UPA-pensioenaangifte
                                      * Cordares
                                      * APG-pensioenaangifte
                                      * Achmea
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      description: The key for the reason for the end of the employment.
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      description: The description of the reason for the end of the employment.
                                      example: VUT
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                endOfEmploymentReasonTaxAuthorities:
                                  description: |-
                                    The reason for the end of the employment as specified by the Dutch Tax authorties. NL: RedenEindeDienstverbandAangifte

                                    __Note:__ This field replaces `endOfEmploymentReason` as of 2020-01-01. `endOfEmploymentReason` will remain as a field in the resource as several integration require this field still.
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      description: The key for the reason for the end of the employment.
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      description: The description of the reason for the end of the employment.
                                      example: Beëindiging arbeidsovereenkomst met wederzijds goedvinden op initiatief van de werkgever.
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                essMutationSet:
                                  description: |-
                                    References to a specified set of payrollcomponents that are to accessible via ESS for employee mutations. Standard-set means the standard set defined for the administration will be applied for this employment. NULL means no set will be defined for this employment (so no access to any components). NL : ExportsetID

                                    `essMutationSet` is a metadata field within the werkgever/provider context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: false
                                  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). NL: CodeUitzondering"
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 0
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Geen uitzondering.
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                exemptionPremiumWaiverMarginalLabour:
                                  description: "Indicates whether an exemption (i.e. waiver) on the premium marginal labour (vrijstelling marginale arbeid) applies for this employment. NL: PremieVrijstellingMarginaleArbeid"
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                exemptionWorkRelatedExpenseScheme:
                                  description: "Indicates whether an exemption (i.e. non-participation) on the work-related expense scheme (werkkostenregeling) applies for this employment. NL: WerkkostenRegelingUitsluiting"
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                firstDayNotification:
                                  description: "Indicates whether a first-day notification (EersteDagsMelding) was created for the employment. Attention: this indication cannot be altered after an employment has been created. NL: EersteDagsMelding "
                                  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. NL: SoortOproepkrachtOfInvalkracht
                                  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. NL: HistorischeDatumInDienst"
                                  example: 2012-05-01
                                  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
                                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. NL: NummerInkomstenVerhouding"
                                  example: 12
                                  format: int32
                                  maximum: 9999
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                isAnonymousEmployee:
                                  description: |
                                    An employee that wants to remain anonymous related to social security instances. NL: IsAnoniemeWerknemer
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                isDirectorAndMajorShareholder:
                                  description: "Indicates whether the employment can be classified as a director and major shareholder (Dutch: directeur-grootaandeelhouder or DGA). This field can be `null` in cases where it is unknown whether the employment can be classified as a director and major shareholder. NL: IsDirecteurGrootAandeelhouder"
                                  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. NL: IsFamilieVanEigenaar"
                                  example: false
                                  nullable: true
                                  readOnly: false
                                  type: boolean
                                isGemoedsbezwaardEmployeeInsurance:
                                  description: |
                                    Gemoedsbezwaard Werknemerverzekering. NL: IsGemoedsbezwaardWerknemerverzekering
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                isGemoedsbezwaardNationalInsurance:
                                  description: |
                                    Gemoedsbezwaard Volksverzekering. NL: IsGemoedsbezwaardVolksverzekering
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                isOnCallEmployment:
                                  description: |
                                    Indicates whether the employment is an on-call employment. This field can be `null` in cases where it is unknown whether the employment is an on-call employment. NL: IsOproepkrachtOfInvalkracht
                                  example: true
                                  nullable: false
                                  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. NL: IsVorigeEigenaar"
                                  example: false
                                  nullable: true
                                  readOnly: false
                                  type: boolean
                                linkedEmployment:
                                  description: The unique identifier of an object (GUID/UUID)
                                  example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                  format: uuid
                                  nullable: true
                                  pattern: ^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$
                                  readOnly: true
                                  type: string
                                namePayslip:
                                  description: "Name that is visible on payslips for the employment. NL: NaamLoonstrook"
                                  example: Steve Jobs
                                  maxLength: 34
                                  nullable: true
                                  readOnly: false
                                  type: string
                                nonPayrollAdministration:
                                  description: |-
                                    Id of the non-payroll administration. This field cannot simultaneously have a value with payrollAdministration (only one can have a value at a time)

                                    `nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                                  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: true
                                      type: string
                                    name:
                                      description: Name of the non payroll administration
                                      example: HR only employees
                                      maxLength: 70
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                participation55plusRegulationUWV:
                                  description: "Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment. NL: Deelname55Plus"
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                payrollAdministration:
                                  description: |-
                                    Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time)

                                    `payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                                  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: true
                                      type: string
                                    name:
                                      description: Name of the payroll administration
                                      example: ABC accountants
                                      maxLength: 70
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                payrollId:
                                  description: "The payrolling number for this employment of the employee. Used by the payroll engine. This number is automatically generated and cannot be changed by the user. NL: PersoneelsnummerVerloning"
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                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’. NL: PeriodeSalarisPeriodiek"
                                  example: 2
                                  format: int32
                                  maximum: 52
                                  minimum: 1
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                professionCode:
                                  description: "A code field for a profession. This field only applies in case of a specific CLA (Bouw / Infra). Please leave empty if not applicable. NL: BeroepUWV"
                                  example: 4
                                  format: int32
                                  maximum: 999
                                  minimum: 1
                                  nullable: true
                                  readOnly: false
                                  type: integer
                                sendToExternalParty:
                                  description: "Indicates whether payroll information of this employment is sent to external pension funds. Attention: this indication ONLY applies regarding the information to pension funds. If NULL then setting according to regulation is leading. NL: AanleveringExternePartij"
                                  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
                                signalPayGradeAdjustment:
                                  description: "Indicates whether signaling regarding salary scale adjustments are enabled for the employment. NL: SalarisschaalSignaleren"
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                specialIncomeRatio:
                                  description: "Indicates the special income ratio. NL: SpecialeInkomstenVerhouding"
                                  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. NL: AanvangOpzegtermijn"
                                  example: 2018-06-01
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                startDate:
                                  description: "The date on which this employment starts. NL: DatumInDienst"
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                startDateContractOfIndefiniteDuration:
                                  description: "When did the value of `employmentDurationType` change for definite to indefinite. NL: Startdatum onbepaalde tijd This value should be te samen as the `startDate` if the contract was indefinite from the start."
                                  example: 2018-05-08
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                temporaryTaxExemption:
                                  description: "Indicates whether there a temporary tax exemption is to be applied for the employment. NL: TijdelijkeHeffingskorting"
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Nee.
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                typeOfEmployee:
                                  description: "A selection of pre defined employee-types for the employment. NL: SoortWerknemer"
                                  format: metadata
                                  nullable: false
                                  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 (product required). NL: AardDeelnemerschap"
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 0
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: n.vt.
                                      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. NL: Vakantiebonnen"
                                  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 (product required). NL: WaardeDeelnemerschap"
                                  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
                                wachtgeldOldRegulation:
                                  description: "Indicates whether the (old) wachtgeld regulation is applicable for the employment. NL: WachtgeldOudeRegeling"
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                writtenEmploymentContract:
                                  description: "Did the employment and employer make a written contract? NL: Schriftelijke overeenkomst"
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                              type: object
                            - properties:
                                workinghours:
                                  properties:
                                    aggregatedHoursPerWeek:
                                      description: |-
                                        This read-only field provides the user with a single point of knowledge as to what number of hours per week employment is actually registered in regards to the payrolling process. This number may be respectively based on the workpattern, deviating hours per week or shift hours. If the employment is an 'on call employment' (oproepkracht/invalkracht) the number is either NULL or represents the min-hours if that is applicable.
                                        This field is especially useful for third-parties that want to know the number of hours per week (without having to apply specific Loket logic). I.e. this field is not visible in Loket GUI.
                                      example: 24
                                      format: double
                                      maximum: 168
                                      minimum: 0.01
                                      nullable: true
                                      pattern: ^(\d{1,2})(\.\d{1,2})?$
                                      readOnly: true
                                      type: number
                                    averageHoursPerWeek:
                                      description: This field can be used to register the average hours per week an employment with varying hours works. For example, 0 hour contracts and min max contracts. The value of this field does NOT directly affect the payrolling proces.
                                      example: 32
                                      format: double
                                      maximum: 168
                                      minimum: 0
                                      nullable: true
                                      pattern: ^(\d{1,3})(\.\d{1,2})?$
                                      readOnly: false
                                      type: number
                                    averageParttimeFactor:
                                      description: |-
                                        This field is used to register the deviating value of the parttimefactor, purely for administrative purposes. The parttimefactor is normally calculated by workinghours dividing by shifthours multplied by 100. 
                                        Please note that this field is not used in the actual payroll proces! For the payroll process the number of hours is used.
                                      format: double
                                      maximum: 999.99
                                      minimum: 0.01
                                      nullable: true
                                      pattern: ^(\d{1,3})(\.\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). Onderliggende elementen geven aan of specifieke waardes berekend moeten worden op basis van het twee wekelijks werkpatroon `workPattern`
                                      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: false
                                          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: false
                                          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: false
                                          readOnly: false
                                          type: boolean
                                        hoursRegularPeriod:
                                          description: Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods.
                                          example: false
                                          nullable: false
                                          readOnly: false
                                          type: boolean
                                        leaveHours:
                                          description: |
                                            Indicates whether then leave balances (verlof) are to be calculated based on the workpattern.  If set to false and the user is not linked to a leave policy with `applyLeaveSchedule` set to true the following fields are used for the calculation `deviatingHoursPerWeek` if null `shift.fullTimeHoursPerWeek` is used
                                          example: true
                                          nullable: false
                                          readOnly: false
                                          type: boolean
                                      type: object
                                    contractCode:
                                      description: |-
                                        This field is specialy made for convenience stores. The field is the type of contract.

                                        `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)
                                          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: If this field is empty the fulltime hours are based as defined by the shift, this optional field is used to register an overwriting value. The value can be less or more then the fulltime hours a week.
                                      example: 32
                                      format: double
                                      maximum: 99.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: 20
                                      format: int32
                                      maximum: 23
                                      minimum: 1
                                      nullable: true
                                      readOnly: false
                                      type: integer
                                    endDate:
                                      description: |
                                        The end date of the entity. The date is up to and including.
                                      example: 2018-10-23
                                      format: date
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    flexibleHoursContract:
                                      description: The field indicates the type of flexible contract. If not applicable, please set to NULL.
                                      format: metadata
                                      nullable: true
                                      properties:
                                        key:
                                          example: 2
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                        value:
                                          example: Minimum uren contract
                                          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
                                    regularWorkPattern:
                                      description: When the employee works the same amount of hours per day every week, then the workpattern is regular.
                                      example: true
                                      nullable: false
                                      readOnly: false
                                      type: boolean
                                    shift:
                                      description: |
                                        The shift determines the full-time hours and bonus percentage.

                                        `shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                      format: metaData
                                      nullable: false
                                      properties:
                                        bonusPercentage:
                                          description: |
                                            The bonus percentage used in wage calculations for the hours made in this shift.
                                          example: 12
                                          maximum: 99
                                          minimum: 0.01
                                          nullable: false
                                          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
                                          nullable: false
                                          readOnly: true
                                          type: number
                                        shiftNumber:
                                          description: |
                                            The number for the shift.
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                      type: object
                                    shiftRateSickLeave:
                                      description: |
                                        The shift determines the full-time hours and bonus percentage.

                                        `shiftRateSickLeave` is a metadata field within the payroll administration context. Possible values can be managed by the user.
                                      format: metadata
                                      properties:
                                        bonusPercentage:
                                          description: |
                                            The bonus percentage used in wage calculations for the hours made in this shift.
                                          example: 12
                                          maximum: 99
                                          minimum: 1
                                          nullable: false
                                          readOnly: true
                                          type: number
                                        fullTimeHoursPerWeek:
                                          description: |
                                            The full time hours for an employment that is linked to this shift.
                                          example: 40
                                          maximum: 99
                                          minimum: 1
                                          nullable: false
                                          readOnly: true
                                          type: number
                                        shiftNumber:
                                          description: |
                                            The key number to identify the shift to be used for calculation of daily rate in case of sick leave (ziekte).
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                      type: object
                                    startDate:
                                      description: |
                                        Start date of the record.

                                        A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                                      example: 2018-01-01
                                      format: date
                                      nullable: false
                                      readOnly: false
                                      type: string
                                    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. <br /> Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                                      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
                            - properties:
                                organizationalEntity:
                                  properties:
                                    department:
                                      description: |-
                                        The department of the employment.

                                        `department` is a metadata field within the employer context. Possible values can be managed by the user.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        code:
                                          example: 2
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        description:
                                          example: Verkoop
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        key:
                                          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
                                      type: object
                                    deviatingFunctionDescription:
                                      description: The deviating function description of the employment. This description deviates from the value of the `function` field.
                                      example: Directeur
                                      maxLength: 50
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    deviatingFunctionGroup:
                                      description: The deviating function group description of the employment. Only applies when a deviating function description is defined.
                                      example: 9A
                                      maxLength: 5
                                      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.

                                        `distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        code:
                                          example: 2
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        description:
                                          example: Sales
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        key:
                                          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
                                      type: object
                                    endDate:
                                      description: The end date of the entity. The date is up to and including.
                                      example: 2018-10-23
                                      format: date
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    function:
                                      description: |-
                                        The function of the employment.

                                        `function` is a metadata field within the employer context. Possible values can be managed by the user.
                                      format: metadata
                                      nullable: false
                                      properties:
                                        description:
                                          example: Directeur
                                          maxLength: 50
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        group:
                                          example: internal
                                          maxLength: 5
                                          nullable: true
                                          readOnly: true
                                          type: string
                                        key:
                                          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
                                      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
                                    internalTelephoneExtensionNumber:
                                      description: The phone number of the standard working location (standplaats) for the employment.
                                      example: "678"
                                      maxLength: 15
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    placeOfEmployment:
                                      description: The standard working location (standplaats) for the employment.
                                      example: Amsterdam office
                                      maxLength: 24
                                      nullable: true
                                      readOnly: false
                                      type: string
                                    standardFunction:
                                      description: |-
                                        The standard (cao)function of the employment.

                                        `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
                                    startDate:
                                      description: |-
                                        The start date of the entity.

                                        A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                                      example: 2018-01-01
                                      format: date
                                      nullable: false
                                      readOnly: false
                                      type: string
                              type: object
                            - properties:
                                wage:
                                  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.
                                      example: true
                                      nullable: true
                                      readOnly: false
                                      type: boolean
                                    employerCosts:
                                      description: |
                                        The cost for the employer for this employee.
                                      example: 3500
                                      format: double
                                      maximum: 99999.99
                                      minimum: 0.01
                                      nullable: true
                                      readOnly: false
                                      type: number
                                    employerCostsType:
                                      description: |
                                        Indicates whether the employer costs are hourly costs or periodic costs. 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.
                                      format: metadata
                                      nullable: true
                                      properties:
                                        key:
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                        value:
                                          example: hourly
                                          maxLength: 50
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      type: object
                                    endDate:
                                      description: |
                                        The end date for the information in the record.
                                      format: date
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    grossWage:
                                      description: |
                                        The gross wage for the employee
                                      example: 2300
                                      format: double
                                      maximum: 999999.99
                                      minimum: 0.01
                                      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.
                                      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
                                    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
                                    isGrossWageFullTime:
                                      description: |
                                        Indicates whether the given grossWage is either a full-time wage or a part-time wage. Full-time wage is the default value (isGrossWageFulltime = true) and Loket.nl recommends to use this option. A full-time wage takes into account the part-time percentage of an employment. While a part-time wage does not. E.g. A full-time wage of 2400 euro’s is registered. The employments works 20 out of 40 hours (40 fours is a full-time shift) thus having a 20/40 = 50% part-time percentage. The part-time hours (deviatingHoursPerWeek) are accessible through the endpoint for working hours of an employement. In the wage calculation Loket.nl will divide the grossWage component by 50% resulting in a grossWage of 1200 euro’s. In the case of a part-time wage the part-time percentage will be ignored.
                                      example: true
                                      nullable: false
                                      readOnly: true
                                      type: boolean
                                    netWage:
                                      description: |
                                        Net wage for the employment
                                      example: 2400
                                      format: double
                                      maximum: 999999.99
                                      minimum: 0.01
                                      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.
                                      format: metadata
                                      nullable: true
                                      properties:
                                        key:
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          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. 

                                        `payGrade` is a metadata field within the payroll administration/payScale 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: 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.

                                        `payScale` 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: Glastuinbouw maand, Loongebouw A
                                          maxLength: 50
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      type: object
                                    payrollPeriodType:
                                      description: |
                                        Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4). The value of this field is used to further specify the meaning of grossWageType, netWageType and employerCostsType. When the key fields of these three wage types have a value 1 (meaning periodic wage), the payrollPeriodType field shows the period type (month, 4 weeks or week) applicable to the wages for the employment. E.g. If the value for grossWageType.key = 1 (periodic wage) and the value for payrollPeriodType.key = 1 (meaning Month), then the wage registerd in grossWage is a monthly wage. Note that in cases where the wage type is an hourly wage (grossWageType.key = 2), the payrollPeriodType should be ignored.
                                      nullable: false
                                      properties:
                                        key:
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        value:
                                          example: Maand
                                          maxLength: 50
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    startDate:
                                      description: |
                                        The start date for the information in the record.

                                        A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                                        __Note__ It is posible to have no wage record.
                                      example: 1995-05-21
                                      format: date
                                      nullable: false
                                      readOnly: false
                                      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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employments with additional entities
      tags:
        - Employment
  "/providers/employers/{employerId}/employees/employments/declarations":
    get:
      description: |
        __Activity name :__ GetDeclarationsByEmployerId

        Returns a list of declarations for the employments of the employer
      operationId: GetDeclarationsForEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            dateOfLastChangeByEmployee:
                              description: The time the declaration was last changed
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            dateOfSubmissionByEmployee:
                              description: The time the declaration was submitted
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            declarationComment:
                              description: The comment left by the employee
                              example: Overwerk project X
                              maxLength: 4000
                              nullable: true
                              readOnly: true
                              type: string
                            declarationDate:
                              description: The date to which the declaration is applicable. As requested by the employee.
                              example: 2017-11-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            declarationStatus:
                              description: |-
                                The current status of the declaration

                                The status is changed by using the PATCH endpoint.

                                1. Open --> Accept or reject
                                2. Goedgekeurd ---> Process
                                3. Geweigerd ---> No changes possible
                                5. Verwerkt ---> No changes possible
                                6. Onverwerkbaar ---> No changes possible
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Open
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            employmentInformation:
                              properties:
                                department:
                                  description: |-
                                    The department of the employment.

                                    `department` is a metadata field within the employer context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: false
                                  properties:
                                    code:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    description:
                                      example: Verkoop
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      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
                                employeeNumber:
                                  description: |
                                    The employee number to uniquely identify an employee within an employer
                                  example: 156
                                  format: int32
                                  minimum: 1
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                firstName:
                                  description: |
                                    The first name, given name, forename or Christian name as part of a persons personal name.
                                  example: Susan
                                  maxLength: 28
                                  minLength: 1
                                  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
                                function:
                                  description: |-
                                    The function of the employment.

                                    `function` is a metadata field within the employer context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: false
                                  properties:
                                    description:
                                      example: Directeur
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    group:
                                      example: internal
                                      maxLength: 5
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    key:
                                      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
                                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
                                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: false
                                  readOnly: true
                                  type: integer
                                payrollAdministration:
                                  description: |-
                                    Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time)

                                    `payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                                  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: true
                                      type: string
                                    name:
                                      description: Name of the payroll administration
                                      example: ABC accountants
                                      maxLength: 70
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                photo:
                                  description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                  example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                  format: url
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              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
                            numberOfUnits:
                              description: The number of units requested
                              example: 8
                              format: double
                              nullable: false
                              pattern: ^(\d{1,3})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            payrollComponent:
                              description: |
                                A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment for the given payroll period. 
                              format: metadata
                              properties:
                                description:
                                  description: |
                                    The description of the payroll component
                                  example: Tijd voor tijd, UREN TVT 130%
                                  maxLength: 14
                                  nullable: false
                                  readOnly: true
                                  type: string
                                key:
                                  description: |
                                    The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know it by heart.
                                  example: 11
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              type: object
                            processedInPayrollPeriod:
                              description: |
                                If the declaration has been succesfully processed then this object will show the payroll period for which a payrollPeriodData has been created.

                                If the declaration has not yet been processed, then the value of this object will be null.
                              format: metadata
                              nullable: true
                              properties:
                                periodEndDate:
                                  description: |
                                    The last day of the period
                                  example: 2018-01-31
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                periodNumber:
                                  description: |
                                    The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period
                                  example: 1
                                  format: int32
                                  maximum: 53
                                  minimum: 1
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                periodStartDate:
                                  description: |
                                    The first day of the period
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                year:
                                  description: |
                                    The year of the payroll period
                                  example: 2017
                                  format: int32
                                  maximum: 9999
                                  minimum: 2000
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 declarations for the employees of an employer
      tags:
        - Declarations
  "/providers/employers/{employerId}/employees/employments/declarations/withattachment":
    get:
      description: |
        __Activity name :__ GetDeclarationsWithAttachmentByEmployerId

        Get a list of all declarationId's of declarations that have an attachment to it. 

        The attachment is stored in Qwoater, and thus on the background a call to Qwoater will be performed to check whether an attachment is available for a declaration.

        If an attachment is available then a call may be performed to the other endpoint to actually start downloading the attachment for this declaration.
      operationId: GetDeclarationsWithAttachmentByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            declarationId:
                              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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 declarations with attachment
      tags:
        - Declarations attachments
  "/providers/employers/{employerId}/employees/employments/lastmodifiedversionnumbers":
    get:
      description: |
        __Activity name :__ GetEmploymentLastModifiedVersionNumbersByEmployerId

        This endpoint is similar to the GetEmployerLastModifiedVersionNumbersByUser endpoint described above. Please check out that description for required context.

        In addition to the version on employer level, this endpoint allows you to check if this employment has any changes since your last synchronization. Consequently, this endpoint may be used to further decrease the amount of required calls when performing a synchronization.

        As can be seen in the set of 'underlying' tables, also changes in Employee information corresponding to the Employment is reflected in the version number.

        **How to use**

        *Recommended usage*
        * Perform all recommended steps in the description of the employer version number endpoint
        * Use the exact SAME filter parameter to this endpoint. The resulting list will contain only the employment for which changes have occured since your last synchronization.
      operationId: GetEmploymentLastModifiedVersionNumbersByUser
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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
                            lastModifiedVersionNumber:
                              description: The version number reflects the latest version of all predefined underlying tables of this employer/employment.
                              example: 70429274999853
                              format: int64
                              nullable: false
                              readOnly: true
                              type: integer
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employment version numbers
      tags:
        - Last modified version numbers
  "/providers/employers/{employerId}/employees/employments/leaverequests":
    get:
      description: |
        __Activity name :__ GetLeaveRequestsByEmployerId

        Returns a list of leave requests for the employments of the employer
      operationId: GetLeaveRequestsForEmployer
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            commentEmployee:
                              description: The comment left by the employee
                              example: Vakantie naar Spanje
                              maxLength: 4000
                              nullable: true
                              readOnly: true
                              type: string
                            commentHandler:
                              description: The comment left by the person handling the leave request
                              example: Fijne vakantie!
                              maxLength: 4000
                              nullable: true
                              readOnly: false
                              type: string
                            currentlyAvailableUnits:
                              description: |-
                                The number of leave units (of the leaveType for this leave request) available to the employment.
                                This value can be negative.
                              example: 140
                              format: double
                              nullable: false
                              readOnly: true
                              type: number
                            endDate:
                              description: The end date of the leave requested (last day of the leave)
                              example: 2017-11-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            handledBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. <lastname>", "<initials>" "<prefix>
                                  example: Jong, I
                                  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 user
                                  example: ABC
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            handledTime:
                              description: The date and time the leave request was handled
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              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
                            isAccrual:
                              default: false
                              description: |
                                Indicates whether the request is for accrual of leave.
                                - false will result in a reduction of the employee's leave entitlement
                                - true will result in an increase of the employee's leave entitlement
                              example: false
                              nullable: false
                              readOnly: false
                              type: boolean
                            leaveRequestStatus:
                              description: |-
                                The current status of the leave request

                                The leave request status is changed by using the PATCH endpoint (not the PUT).

                                The following transitions are possible
                                * leaveRequestStatus = submitted -> accepted or rejected
                                * leaveRequestStatus = accepted -> no changes possible
                                * leaveRequestStatus = rejected -> submitted
                                * leaveRequestStatus = revoked by user -> no changes possible
                                * leaveRequestStatus = related leave deleted -> no changes possible
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 9
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Geaccepteerd
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            leaveType:
                              description: |-
                                The type of leave requested by the employee

                                `leaveType` is a metadata field within the employer context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Verlof (bovenwettelijk)
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            numberOfUnits:
                              description: The number of leave units requested
                              example: 8
                              format: double
                              maximum: 999.99
                              minimum: 0.01
                              nullable: false
                              pattern: ^(\d{1,3})(\.\d{1,2})?$
                              readOnly: false
                              type: number
                            startDate:
                              description: The start date of the leave requested
                              example: 2017-11-01
                              format: date
                              nullable: false
                              readOnly: false
                              type: string
                            submittedBy:
                              format: metadata
                              nullable: false
                              properties:
                                dateOfBirth:
                                  description: |
                                    The date of birth
                                  example: 1995-05-21
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                employeeNumber:
                                  description: The employee number to uniquely identify a employee within a 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
                                lastNamePartner:
                                  description: The last name of the partner of the employee
                                  example: Wiel
                                  maxLength: 25
                                  nullable: true
                                  readOnly: true
                                  type: string
                                photo:
                                  description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                  example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                  format: url
                                  nullable: true
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the employee
                                  example: van
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                                prefixPartner:
                                  description: The prefix of the partner of the employee
                                  example: van de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            submittedOn:
                              description: The time the leave request was submitted
                              example: 2018-05-08T15:16:49+02:00
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            unitType:
                              description: If known indicates what the unit type (hours or days) is for `numberOfUnits`. Otherwise the field will be null.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  description: |
                                    The key for the unit type
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    The description for the unit type
                                  example: Uren
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 leave requests for the employees of an employer
      tags:
        - Leave request
  "/providers/employers/{employerId}/employees/employments/minimized":
    get:
      description: |
        __Activity name :__ GetEmploymentsMinimizedByEmployerId

        Get a list of employments for an employer.  With this version we introduced the "Minimized" resource which contains fewer fields.  This version should increase performance when requesting employments for large employer.

        This endpoint only returns the employments that meet the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
      operationId: GetEmploymentsMinimizedByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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=2019-12-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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          allOf:
                            - properties:
                                employee:
                                  properties:
                                    dateOfBirth:
                                      description: |
                                        The date of birth
                                      example: 1995-05-21
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    employeeNumber:
                                      description: The employee number to uniquely identify a employee within a 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
                                    photo:
                                      description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                      example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                      format: url
                                      nullable: true
                                      readOnly: true
                                      type: string
                                  type: object
                              type: object
                            - properties:
                                commissionUntilDate:
                                  description: "The date on which the employment will end. NL: AanstellingTot"
                                  example: 2019-01-01
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                employmentDurationType:
                                  description: "A selection of pre defined durations for the employment. NL: SoortDienstverband"
                                  format: metadata
                                  nullable: false
                                  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
                                endDate:
                                  description: "The date on which the employment ends. NL: DatumUitDienst"
                                  example: 2018-10-23
                                  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
                                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. NL: NummerInkomstenVerhouding"
                                  example: 12
                                  format: int32
                                  maximum: 9999
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                nonPayrollAdministration:
                                  description: |-
                                    Id of the non-payroll administration. This field cannot simultaneously have a value with payrollAdministration (only one can have a value at a time)

                                    `nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                                  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: true
                                      type: string
                                    name:
                                      description: Name of the non payroll administration
                                      example: HR only employees
                                      maxLength: 70
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                payrollAdministration:
                                  description: |-
                                    Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time)

                                    `payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                                  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: true
                                      type: string
                                    name:
                                      description: Name of the payroll administration
                                      example: ABC accountants
                                      maxLength: 70
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  type: object
                                payrollId:
                                  description: "The payrolling number for this employment of the employee. Used by the payroll engine. This number is automatically generated and cannot be changed by the user. NL: PersoneelsnummerVerloning"
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                startDate:
                                  description: "The date on which this employment starts. NL: DatumInDienst"
                                  example: 2018-01-01
                                  format: date
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employments with fewer fields for performance reasons
      tags:
        - Employment
  "/providers/employers/{employerId}/employees/employments/wages":
    post:
      description: |
        __Activity name :__ PostCollectiveWageByEmployerId

        Create new grosswage records for multiple employments of an employer
      operationId: PostCollectiveWageByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                employmentId:
                  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
                grossWage:
                  description: |
                    The gross wage for the employee
                  example: 2300
                  format: double
                  maximum: 999999.99
                  minimum: 0.01
                  nullable: true
                  readOnly: false
                  type: number
                startDate:
                  description: |
                    The start date for the information in the record.

                    A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                    __Note__ It is posible to have no wage record.
                  example: 1995-05-21
                  format: date
                  nullable: false
                  readOnly: false
                  type: string
        description: Wages to add.
        required: true
      responses:
        "202":
          description: Accepted
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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 wages for multiple employments
      tags:
        - Collective wage
  "/providers/employers/{employerId}/employees/selfservice":
    get:
      description: |
        __Activity name :__ GetEmployeeSelfServiceByEmployerId

        Get a list of all the employee's and their status regarding to ESS (werknemer.loket).
      operationId: GetEmployeeSelfServiceByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            employee:
                              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
                            hasTwoFactorAuthentication:
                              description: Does the employee have two factor authentication enabled
                              example: false
                              nullable: false
                              readOnly: true
                              type: boolean
                            status:
                              description: Description of the status
                              enum:
                                - HasAccessToClient
                                - NoAccessToClient
                                - UserIsBlocked
                                - AccessToClientIsBlocked
                                - InvitePending
                                - InviteFailed
                                - InviteCancelled
                                - InviteExpired
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employee's and their ESS (WNL) status
      tags:
        - Employee self service
    patch:
      description: |
        __Activity name :__ PatchEmployeeSelfServiceAccessByEmployerId

        This endpoint allows the user to change the status of access to ESS for several employees of the employer.
      operationId: PatchEmployeeSelfServiceAccessByEmployerId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: employerId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              items:
                properties:
                  action:
                    description: The action to be taken for the given employee
                    enum:
                      - SendInvite
                      - RevokeInvite
                      - RevokeAccess
                      - ReinstateAccess
                      - ResendUsername
                      - DisableTwoFactorAuthentication
                    maxLength: 50
                    nullable: false
                    readOnly: false
                    type: string
                  employeeId:
                    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
              type: array
        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Change the ESS access for several employees
      tags:
        - Employee self service
  "/providers/employers/{employerId}/employmenttemplates":
    get:
      description: |
        __Activity name :__ GetEmploymentTemplatesByEmployerId
        Get the employment templates that are available at this employer's level. 

        An employment templates (werknemersjabloon) provides as predefined set of values for a new employment.  This is mostly when creating a new employee or employment as this allows the user to apply the template's values and augment this with any specific values.
      operationId: GetEmploymentTemplatesByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          description: The aggregated employment templates
                          nullable: false
                          properties:
                            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: 2019-05-31
                                  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: 2019-01-01
                                  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

                                    `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

                                    `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: 2012-05-01
                                  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`

                                    `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`

                                    `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: 2019-06-01
                                  format: date
                                  nullable: true
                                  readOnly: false
                                  type: string
                                startDate:
                                  description: The date on which this employment starts.
                                  example: 2019-01-01
                                  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: 2018-05-08
                                  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.
                                  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.

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

                                    `distributionUnit` 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: 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.

                                    `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)
                                      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.

                                    `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
                            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
                            templateName:
                              description: Name of the templat
                              example: Sjabloon voor Oproepkracht
                              maxLength: 255
                              minLength: 1
                              nullable: false
                              readOnly: true
                              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. 
                                  example: true
                                  nullable: true
                                  readOnly: false
                                  type: boolean
                                grossWage:
                                  description: |
                                    The gross wage for the employee
                                  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.
                                  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
                                  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.
                                  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. 

                                    `payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                                  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.

                                    `payScale` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.
                                  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.

                                    `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)
                                      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.

                                    `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. <br /> Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                                  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
                          readOnly: true
                          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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Employment templates
      tags:
        - Employment template
  "/providers/employers/{employerId}/externaltenants":
    get:
      description: |
        __Activity name:__ GetExternalTenantsByEmployerId
            

        Get a list of external tenants that are available within the scope of this employer.
        An external tenant may be registered for a Loket user, and may be used to login to Loket using Azure Active Directory. 
      operationId: GetExternalTenantsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: false
                          properties:
                            externalId:
                              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
                            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: The user-friendly name of the external tenant
                              example: Loket tenant
                              maxLength: 28
                              nullable: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 available external tenants (employer scope)
      tags:
        - External tenant
  "/providers/employers/{employerId}/functions":
    get:
      description: |
        __Activity name :__ GetFunctionsByEmployerId

        Get a list of all functions for the employer. This is the point where the functions available for use at employment level (organizational entity) are managed.
      operationId: GetFunctionsByEmployerId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 employer
          in: path
          name: employerId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            description:
                              example: Directeur
                              maxLength: 50
                              nullable: false
                              readOnly: false
                              type: string
                            group:
                              example: Var
                              maxLength: 5
                              nullable: true
                              readOnly: false
                              type: string
                            key:
                              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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 functions
      tags:
        - Functions
    post:
      description: |
        __Activity name:__ PostFunctionByEmployerId
            

        Create a function for an employer

        __Metadata:__ No metadata

        __Defaults:__ No default values
      operationId: PostFunctionByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                  example: Directeur
                  maxLength: 50
                  nullable: false
                  readOnly: false
                  type: string
                group:
                  example: Var
                  maxLength: 5
                  nullable: true
                  readOnly: false
                  type: string
                key:
                  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
        description: Function to add to the employer.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          description:
                            example: Directeur
                            maxLength: 50
                            nullable: false
                            readOnly: false
                            type: string
                          group:
                            example: Var
                            maxLength: 5
                            nullable: true
                            readOnly: false
                            type: string
                          key:
                            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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 function for an employer
      tags:
        - Functions
  "/providers/employers/{employerId}/leave":
    post:
      description: |
        __Activity name:__ PostCollectiveLeaveByEmployerId

        Post leave for a set of employments under an employer.

        __Metadata :__ There is no metadata endpoint for this resource.

        __Defaults :__ Defaults are available at /defaults.
      operationId: PostCollectiveLeaveByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                  comments:
                    description: |
                      Any comments on the leave.
                    example: This leave is added.
                    maximum: 4000
                    nullable: true
                    readOnly: false
                    type: string
                  employmentId:
                    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
                  endDate:
                    description: |
                      The end date for the leave.
                    example: 2022-10-22
                    format: date
                    nullable: false
                    readOnly: false
                    type: string
                  isAccrual:
                    description: |
                      Indicates whether the leave should be added(true) or subtracted(false).
                    example: true
                    nullable: false
                    readOnly: false
                    type: boolean
                  leaveType:
                    description: |
                      The id of the leavetype.
                    example: 1
                    format: int32
                    nullable: false
                    readOnly: false
                    type: integer
                  numberOfUnits:
                    description: |
                      The amount of leave.
                    example: 4.5
                    format: double
                    maximum: 999.99
                    nullable: false
                    pattern: ^(\d{1,6})(.\d{1,2})?$
                    readOnly: false
                    type: number
                  startDate:
                    description: |
                      The start date for the leave.
                    example: 2022-10-21
                    format: date
                    nullable: false
                    readOnly: false
                    type: string
              type: array
        description: Array of Leave objects
        required: true
      responses:
        "202":
          description: OK. the specified leave is applied to the selected employments.
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Post leave for multiple employments.
      tags:
        - Collective leave
  "/providers/employers/{employerId}/leave/proposedleavehours":
    get:
      description: |
        __Activity name :__ GetProposedLeaveHoursByEmployerId

        Returns the numberOfHours (only in hours) calculated based on the employments working- hours/schedual 

        __Note:__  The function will only work if the employment is either linked to no leave policy or linked to only leave policy(s) that use hours as the unit of leave.

        Further more how the leave hours are calculated can be managed in the leave policy with the `applyLeaveSchedule` and `working hours` resource with the field `calculateUsingWorkPattern.leaveHours` The order is as follows. If calculateUsingWorkPattern.leaveHours is true the work patern from workinghours is used otherwise if applyLeaveSchedule is set to true the `leavePattern` is used otherwise the workinghours are used
      operationId: GetProposedLeaveHoursByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          required: true
          schema:
            format: uuid
            type: string
        - description: The start date of the leave period
          in: query
          name: startDate
          schema:
            example: 2022-08-01
            pattern: date
            type: string
        - description: The end date of the leave period
          in: query
          name: endDate
          schema:
            example: 2022-08-07
            pattern: date
            type: string
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            additionalInformation:
                              description: Provides additional information on the calculation.
                              example: Additional information on the calculation.
                              nullable: true
                              readOnly: true
                              type: string
                            employmentId:
                              description: The unique identifier (a 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
                            methodOfCalculation:
                              description: Indicates which method was used to calculate the proposed leave hours.
                              example: Ploeguren
                              nullable: false
                              readOnly: true
                              type: string
                            proposedLeaveHours:
                              description: The proposed number of leave hours
                              example: 8
                              format: double
                              nullable: false
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the proposed number of leave hours for all employments of an employer
      tags:
        - Leave
  "/providers/employers/{employerId}/leavePolicies":
    get:
      description: |
        __Activity name :__ GetLeavePoliciesByEmployerId <br/>  <br/>  Returns all the leave policies for the given employer.
      operationId: GetLeavePoliciesByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            accrualType:
                              description: "Indicates how leave is accrued (yearly, monthly or hourly)  "
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: |
                                    The key for the `accrualType`
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    The description for the `accrualType`
                                  example: Jaar
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              type: object
                            additionalLeave:
                              nullable: false
                              properties:
                                allocationType:
                                  description: Indicates how additional leave is to be assigned to the employments (linked to this leave policy).
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      description: |
                                        The key for the `additionalLeaveAllocationType`
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      description: |
                                        The description for the `additionalLeaveAllocationType`
                                      example: Boek alleen hoogste waarde
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: false
                                  type: object
                                referenceDate1:
                                  description: If `referenceDate2` has a value only the last 6 months of the year are allowed as values
                                  nullable: false
                                  properties:
                                    day:
                                      description: The day of the first reference date.
                                      example: 40
                                      format: int32
                                      maximum: 31
                                      minimum: 1
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    month:
                                      description: "The month of the first reference date "
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          description: |
                                            The key for the `referenceMonth`
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                        value:
                                          description: |
                                            The description for the `referenceMonth`
                                          example: Januari
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: false
                                      type: object
                                  type: object
                                referenceDate2:
                                  description: Only use if applicable
                                  nullable: true
                                  properties:
                                    day:
                                      description: The day of the second reference date.
                                      example: 40
                                      format: int32
                                      maximum: 31
                                      minimum: 1
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    month:
                                      description: "The month of the second reference date "
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          description: |
                                            The key for the `referenceMonth`
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                        value:
                                          description: |
                                            The description for the `referenceMonth`
                                          example: Januari
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: false
                                      type: object
                                  type: object
                              readOnly: false
                              type: object
                            dayOfTheMonthToPerformAutomaticLeaveCalculationOn:
                              description: |-
                                They day of the month on which the automatic accrual of (yearly or monthly) leave is performed. The yearly calculation is repeated every month to encompase any changes made that have affect on the past.
                                If for example 31 is chosen and a specific month does not have that day the logic will pick the first available date of said month.          
                              example: 12
                              format: int32
                              maximum: 31
                              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
                            leaveEntitlement:
                              nullable: true
                              properties:
                                excessLeaveToStatutory:
                                  description: The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.
                                  example: 40
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,3})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                statutory:
                                  description: The statutory leave (wetelijk verlof) linked employments are entitled to for a full time contract.
                                  example: 160
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,3})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                wtr:
                                  description: The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                  example: 40
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,3})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                              readOnly: false
                              type: object
                            leaveRequest:
                              nullable: false
                              properties:
                                applyLeaveSchedule:
                                  description: Indicates whether the leave schedule can be enterd and is so it is used when calculating the sugested leave hours for a leave request
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                leavePattern:
                                  description: |
                                    The applicable leave pattern for a period of 2 weeks can be stored in this object. Each field contains the number of leave(work) hours for that day in the 2-week period. <br /> Please note that the `leavePattern` should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                                  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
                                useHolidaysInCalculation:
                                  description: |-
                                    Indicates whether the calculating for sugested leave hours for a leave request takes into account holidays. Is set to true no leave hours are calculated for "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."

                                    eg. When requesting leave for the 24th and 25th of december (25th being a national holiday) the calculation (8 hours a day) will return 8 when `useHolidaysInCalculation` is true and 16 when `useHolidaysInCalculation` is false
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                              readOnly: false
                              type: object
                            leaveUnitType:
                              description: Indicates what the unit type (hours or days) is. Employments linked to this leave policy use this leaveUnitType for their leave.
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: |
                                    The key for the unit type
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    The description for the leave unit type
                                  example: Uren
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              type: object
                            name:
                              description: The name of the leave policy
                              example: Normal leave
                              maxLength: 50
                              minLength: 1
                              nullable: false
                              readOnly: false
                              type: string
                            payoutLeaveImmediately:
                              description: If leave `accrualType` is set to based on hours worked (uren) then this field allows for the leave hours to be paid out directly instead of being accrued.
                              example: false
                              nullable: false
                              readOnly: false
                              type: boolean
                            roundTo:
                              description: Indicates to how many digits after the decimal point to round the numbers
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: |
                                    The key for the roundTo
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    The description for the roundTo
                                  example: "0.01"
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              type: object
                            roundingMethod:
                              description: "Indicates how to round the numbers "
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: |
                                    The key for the roundingMethod
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    The description for the roundingMethod
                                  example: Logical
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 all the leave policies
      tags:
        - Leave policy
    patch:
      description: |
        __Activity name :__ PatchCopyLeavePolicyByEmployerId

        Add a leave policy based on an existing leave policy at providerlevel. (Create a copy)
      operationId: PatchCopyLeavePolicyByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                name:
                  description: The name of the leave policy
                  example: Verlofregeling Metaal CAO
                  maxLength: 50
                  minLength: 1
                  nullable: true
                  readOnly: false
                  type: string
                sourceLeavePolicyId:
                  description: The unique identifier of the Leave policy at providerlevel which should be copied.
                  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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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)
                            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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 leave policy based on an existing leave policy
      tags:
        - Leave policy
    post:
      description: |
        __Activity name :__ PostLeavePolicyByEmployerId

        Add a leave policy
      operationId: PostLeavePolicyByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                accrualType:
                  description: "Indicates how leave is accrued (yearly, monthly or hourly)  "
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      description: |
                        The key for the `accrualType`
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        The description for the `accrualType`
                      example: Jaar
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
                additionalLeave:
                  nullable: false
                  properties:
                    allocationType:
                      description: Indicates how additional leave is to be assigned to the employments (linked to this leave policy).
                      format: metadata
                      nullable: false
                      properties:
                        key:
                          description: |
                            The key for the `additionalLeaveAllocationType`
                          example: 1
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          description: |
                            The description for the `additionalLeaveAllocationType`
                          example: Boek alleen hoogste waarde
                          nullable: false
                          readOnly: true
                          type: string
                      readOnly: false
                      type: object
                    referenceDate1:
                      description: If `referenceDate2` has a value only the last 6 months of the year are allowed as values
                      nullable: false
                      properties:
                        day:
                          description: The day of the first reference date.
                          example: 40
                          format: int32
                          maximum: 31
                          minimum: 1
                          nullable: false
                          readOnly: false
                          type: integer
                        month:
                          description: "The month of the first reference date "
                          format: metadata
                          nullable: false
                          properties:
                            key:
                              description: |
                                The key for the `referenceMonth`
                              example: 1
                              format: int32
                              nullable: false
                              readOnly: false
                              type: integer
                            value:
                              description: |
                                The description for the `referenceMonth`
                              example: Januari
                              nullable: false
                              readOnly: true
                              type: string
                          readOnly: false
                          type: object
                      type: object
                    referenceDate2:
                      description: Only use if applicable
                      nullable: true
                      properties:
                        day:
                          description: The day of the second reference date.
                          example: 40
                          format: int32
                          maximum: 31
                          minimum: 1
                          nullable: false
                          readOnly: false
                          type: integer
                        month:
                          description: "The month of the second reference date "
                          format: metadata
                          nullable: false
                          properties:
                            key:
                              description: |
                                The key for the `referenceMonth`
                              example: 1
                              format: int32
                              nullable: false
                              readOnly: false
                              type: integer
                            value:
                              description: |
                                The description for the `referenceMonth`
                              example: Januari
                              nullable: false
                              readOnly: true
                              type: string
                          readOnly: false
                          type: object
                      type: object
                  readOnly: false
                  type: object
                dayOfTheMonthToPerformAutomaticLeaveCalculationOn:
                  description: |-
                    They day of the month on which the automatic accrual of (yearly or monthly) leave is performed. The yearly calculation is repeated every month to encompase any changes made that have affect on the past.
                    If for example 31 is chosen and a specific month does not have that day the logic will pick the first available date of said month.          
                  example: 12
                  format: int32
                  maximum: 31
                  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
                leaveEntitlement:
                  nullable: true
                  properties:
                    excessLeaveToStatutory:
                      description: The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.
                      example: 40
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,3})(.\d{1,2})?$
                      readOnly: false
                      type: number
                    statutory:
                      description: The statutory leave (wetelijk verlof) linked employments are entitled to for a full time contract.
                      example: 160
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,3})(.\d{1,2})?$
                      readOnly: false
                      type: number
                    wtr:
                      description: The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                      example: 40
                      format: double
                      maximum: 999.99
                      minimum: 0.01
                      nullable: true
                      pattern: ^(\d{1,3})(.\d{1,2})?$
                      readOnly: false
                      type: number
                  readOnly: false
                  type: object
                leaveRequest:
                  nullable: false
                  properties:
                    applyLeaveSchedule:
                      description: Indicates whether the leave schedule can be enterd and is so it is used when calculating the sugested leave hours for a leave request
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                    leavePattern:
                      description: |
                        The applicable leave pattern for a period of 2 weeks can be stored in this object. Each field contains the number of leave(work) hours for that day in the 2-week period. <br /> Please note that the `leavePattern` should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                      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
                    useHolidaysInCalculation:
                      description: |-
                        Indicates whether the calculating for sugested leave hours for a leave request takes into account holidays. Is set to true no leave hours are calculated for "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."

                        eg. When requesting leave for the 24th and 25th of december (25th being a national holiday) the calculation (8 hours a day) will return 8 when `useHolidaysInCalculation` is true and 16 when `useHolidaysInCalculation` is false
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                  readOnly: false
                  type: object
                leaveUnitType:
                  description: Indicates what the unit type (hours or days) is. Employments linked to this leave policy use this leaveUnitType for their leave.
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      description: |
                        The key for the unit type
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        The description for the leave unit type
                      example: Uren
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
                name:
                  description: The name of the leave policy
                  example: Normal leave
                  maxLength: 50
                  minLength: 1
                  nullable: false
                  readOnly: false
                  type: string
                payoutLeaveImmediately:
                  description: If leave `accrualType` is set to based on hours worked (uren) then this field allows for the leave hours to be paid out directly instead of being accrued.
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                roundTo:
                  description: Indicates to how many digits after the decimal point to round the numbers
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      description: |
                        The key for the roundTo
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        The description for the roundTo
                      example: "0.01"
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
                roundingMethod:
                  description: "Indicates how to round the numbers "
                  format: metadata
                  nullable: false
                  properties:
                    key:
                      description: |
                        The key for the roundingMethod
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: |
                        The description for the roundingMethod
                      example: Logical
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: false
                  type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          accrualType:
                            description: "Indicates how leave is accrued (yearly, monthly or hourly)  "
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The key for the `accrualType`
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the `accrualType`
                                example: Jaar
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          additionalLeave:
                            nullable: false
                            properties:
                              allocationType:
                                description: Indicates how additional leave is to be assigned to the employments (linked to this leave policy).
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The key for the `additionalLeaveAllocationType`
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: |
                                      The description for the `additionalLeaveAllocationType`
                                    example: Boek alleen hoogste waarde
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: false
                                type: object
                              referenceDate1:
                                description: If `referenceDate2` has a value only the last 6 months of the year are allowed as values
                                nullable: false
                                properties:
                                  day:
                                    description: The day of the first reference date.
                                    example: 40
                                    format: int32
                                    maximum: 31
                                    minimum: 1
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  month:
                                    description: "The month of the first reference date "
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        description: |
                                          The key for the `referenceMonth`
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        description: |
                                          The description for the `referenceMonth`
                                        example: Januari
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    readOnly: false
                                    type: object
                                type: object
                              referenceDate2:
                                description: Only use if applicable
                                nullable: true
                                properties:
                                  day:
                                    description: The day of the second reference date.
                                    example: 40
                                    format: int32
                                    maximum: 31
                                    minimum: 1
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  month:
                                    description: "The month of the second reference date "
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        description: |
                                          The key for the `referenceMonth`
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        description: |
                                          The description for the `referenceMonth`
                                        example: Januari
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    readOnly: false
                                    type: object
                                type: object
                            readOnly: false
                            type: object
                          dayOfTheMonthToPerformAutomaticLeaveCalculationOn:
                            description: |-
                              They day of the month on which the automatic accrual of (yearly or monthly) leave is performed. The yearly calculation is repeated every month to encompase any changes made that have affect on the past.
                              If for example 31 is chosen and a specific month does not have that day the logic will pick the first available date of said month.          
                            example: 12
                            format: int32
                            maximum: 31
                            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
                          leaveEntitlement:
                            nullable: true
                            properties:
                              excessLeaveToStatutory:
                                description: The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                              statutory:
                                description: The statutory leave (wetelijk verlof) linked employments are entitled to for a full time contract.
                                example: 160
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                              wtr:
                                description: The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          leaveRequest:
                            nullable: false
                            properties:
                              applyLeaveSchedule:
                                description: Indicates whether the leave schedule can be enterd and is so it is used when calculating the sugested leave hours for a leave request
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              leavePattern:
                                description: |
                                  The applicable leave pattern for a period of 2 weeks can be stored in this object. Each field contains the number of leave(work) hours for that day in the 2-week period. <br /> Please note that the `leavePattern` should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                                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
                              useHolidaysInCalculation:
                                description: |-
                                  Indicates whether the calculating for sugested leave hours for a leave request takes into account holidays. Is set to true no leave hours are calculated for "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."

                                  eg. When requesting leave for the 24th and 25th of december (25th being a national holiday) the calculation (8 hours a day) will return 8 when `useHolidaysInCalculation` is true and 16 when `useHolidaysInCalculation` is false
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                            readOnly: false
                            type: object
                          leaveUnitType:
                            description: Indicates what the unit type (hours or days) is. Employments linked to this leave policy use this leaveUnitType for their leave.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The key for the unit type
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the leave unit type
                                example: Uren
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          name:
                            description: The name of the leave policy
                            example: Normal leave
                            maxLength: 50
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          payoutLeaveImmediately:
                            description: If leave `accrualType` is set to based on hours worked (uren) then this field allows for the leave hours to be paid out directly instead of being accrued.
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          roundTo:
                            description: Indicates to how many digits after the decimal point to round the numbers
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The key for the roundTo
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the roundTo
                                example: "0.01"
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          roundingMethod:
                            description: "Indicates how to round the numbers "
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The key for the roundingMethod
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the roundingMethod
                                example: Logical
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 leave policy
      tags:
        - Leave policy
  "/providers/employers/{employerId}/leavebalances":
    get:
      description: |
        __Activity name :__ GetLeaveBalancesByEmployerId <br/>  <br/>  Returns the yearly leave balances for all employments
      operationId: GetLeaveBalancesByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: |-
            Set a reference date for the following logic
              1. To determine the active `function` and `department` of the employment
              2. To calculate `usageAfterToday` and `usageThroughToday`
              3. To determine the year for which the leave balance is returned

            If not provided, "today" is used
          in: query
          name: referenceDate
          required: false
          schema:
            example: 2020-12-31
            format: date
            type: string
        - description: |-
            Select which `leaveType` will be returned. Based on the provided 'leaveType.key'(s)

            If not provided, the `leaveType` 16 (Verlof) is returned (16 is the sum of leaveType 1 (bovenwettelijk verlof) and 15 (wettelijk verlof))
          in: query
          name: leaveType
          required: false
          schema:
            items:
              example:
                - 1
                - 15
                - 99
              type: integer
            type: array
        - 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            employee:
                              format: metadata
                              nullable: false
                              properties:
                                dateOfBirth:
                                  description: |
                                    The date of birth
                                  example: 1995-05-21
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                employeeNumber:
                                  description: The employee number to uniquely identify a employee within a 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
                                lastNamePartner:
                                  description: The last name of the partner of the employee
                                  example: Wiel
                                  maxLength: 25
                                  nullable: true
                                  readOnly: true
                                  type: string
                                photo:
                                  description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                  example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                  format: url
                                  nullable: true
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the employee
                                  example: van
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                                prefixPartner:
                                  description: The prefix of the partner of the employee
                                  example: van de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            endDate:
                              description: "The date on which the employment ends. NL: DatumUitDienst"
                              example: 2018-10-23
                              format: date
                              nullable: true
                              readOnly: true
                              type: string
                            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. NL: HistorischeDatumInDienst"
                              example: 2012-05-01
                              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
                            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. NL: NummerInkomstenVerhouding"
                              example: 12
                              format: int32
                              maximum: 9999
                              nullable: false
                              readOnly: false
                              type: integer
                            leaveBalance:
                              items:
                                properties:
                                  accrual:
                                    description: |
                                      The amount of leave units accrued for the leave type in the year
                                    example: 30
                                    format: double
                                    nullable: false
                                    pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                    readOnly: true
                                    type: number
                                  balance:
                                    description: |
                                      The remaining leave balance for the year and leave type. The balance takes into account the leave usage in the future.
                                    example: 40
                                    format: double
                                    nullable: false
                                    pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                    readOnly: true
                                    type: number
                                  balancePreviousYear:
                                    description: |
                                      The remaining leave balance from the previous year for the leave type
                                    example: 20
                                    format: double
                                    nullable: false
                                    pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                    readOnly: true
                                    type: number
                                  expires:
                                    description: |
                                      <ul>
                                        <li>This field is only relevant for the following leave types:</li>
                                        <li><strong>Wettelijk verlof:</strong> Accrued statutory leave from previous years that expires on July 1 of the selected year.</li>
                                        <li><strong>Bovenwettelijk verlof:</strong> Accrued extra-legal leave from 5 years ago and earlier, which expires on Jan 1 of the selected year + 1.</li>
                                        <li><strong>Verlof:</strong> The sum of the two leave types above.</li>
                                      </ul>
                                    example: 15
                                    format: double
                                    nullable: false
                                    pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                    readOnly: true
                                    type: number
                                  leaveType:
                                    description: |-
                                      The type of leave requested by the employee
                                      `leaveType` is a metadata field within the employer context. Possible values can be managed by the user.
                                    format: metadata
                                    nullable: false
                                    properties:
                                      balanceExceedsYear:
                                        description: |
                                          Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                                        example: true
                                        nullable: false
                                        readOnly: true
                                        type: boolean
                                      key:
                                        description: |
                                          The key for the leave type.
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: true
                                        type: integer
                                      value:
                                        description: |
                                          The description for the leave type. Note that leave types can be overridden at the employer level. In these cases the description at the employer level takes precedence over the default description of the leave type.
                                        example: Verlof (bovenwettelijk)
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                  usageAfterReferenceDate:
                                    description: |
                                      The amount of leave units used for the leave type in the year after `referenceDate`
                                    example: 2
                                    format: double
                                    minimum: 0
                                    nullable: false
                                    pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                    readOnly: true
                                    type: number
                                  usageThroughReferenceDate:
                                    description: |
                                      The amount of leave units used for the leave type starting from the beginning of the year up to and `referenceDate` 
                                    example: 8
                                    format: double
                                    nullable: false
                                    pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                    readOnly: true
                                    type: number
                                  usageTotal:
                                    description: |
                                      The total amount of leave units used for the leave type in the year.
                                    example: 10
                                    format: double
                                    nullable: false
                                    pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                    readOnly: true
                                    type: number
                                  year:
                                    description: |
                                      The year to which the balance of the leave type applies.
                                    example: 2019
                                    format: int32
                                    maximum: 9999
                                    minimum: 2000
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                type: object
                              type: array
                            nonPayrollAdministration:
                              description: |-
                                Id of the non-payroll administration. This field cannot simultaneously have a value with payrollAdministration (only one can have a value at a time)

                                `nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                              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: true
                                  type: string
                                name:
                                  description: Name of the non payroll administration
                                  example: HR only employees
                                  maxLength: 70
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            organizationalEntity:
                              nullable: false
                              properties:
                                department:
                                  description: |-
                                    The department of the employment.

                                    `department` is a metadata field within the employer context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: false
                                  properties:
                                    code:
                                      example: 2
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    description:
                                      example: Verkoop
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      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
                                  type: object
                                deviatingFunctionDescription:
                                  description: The deviating function description of the employment. This description deviates from the value of the `function` field.
                                  example: Directeur
                                  maxLength: 50
                                  nullable: true
                                  readOnly: false
                                  type: string
                                deviatingFunctionGroup:
                                  description: The deviating function group description of the employment. Only applies when a deviating function description is defined.
                                  example: 9A
                                  maxLength: 5
                                  nullable: true
                                  readOnly: false
                                  type: string
                                endDate:
                                  description: The end date of the entity. The date is up to and including.
                                  example: 2018-10-23
                                  format: date
                                  nullable: true
                                  readOnly: true
                                  type: string
                                function:
                                  description: |-
                                    The function of the employment.

                                    `function` is a metadata field within the employer context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: false
                                  properties:
                                    description:
                                      example: Directeur
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    group:
                                      example: internal
                                      maxLength: 5
                                      nullable: true
                                      readOnly: true
                                      type: string
                                    key:
                                      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
                                  type: object
                                placeOfEmployment:
                                  description: The standard working location (standplaats) for the employment.
                                  example: Amsterdam office
                                  maxLength: 24
                                  nullable: true
                                  readOnly: false
                                  type: string
                                standardFunction:
                                  description: |-
                                    The standard (cao)function of the employment.

                                    `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
                                startDate:
                                  description: |-
                                    The start date of the entity.

                                    A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
                                  example: 2018-01-01
                                  format: date
                                  nullable: false
                                  readOnly: false
                                  type: string
                              readOnly: true
                              type: object
                            payrollAdministration:
                              description: |-
                                Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time)

                                `payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.
                              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: true
                                  type: string
                                name:
                                  description: Name of the payroll administration
                                  example: ABC accountants
                                  maxLength: 70
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            startDate:
                              description: "The date on which this employment starts. NL: DatumInDienst"
                              example: 2018-01-01
                              format: date
                              nullable: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: The leave balance for all employments
      tags:
        - Leave balance
  "/providers/employers/{employerId}/leavebalances/grouped":
    get:
      description: |
        __Activity name :__ GetLeaveBalancesGroupedByEmployerId <br/>  <br/>  Returns the yearly leave balances total per leave type and total per groupBy
      operationId: GetLeaveBalancesGroupedByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: |-
            Set a reference date for the following logic
              1. To determine the active `function` and `department` of the employment
              2. To calculate `usageAfterToday` and `usageThroughToday`
              3. To determine the year for which the leave balance is returned

            If not provided, "today" is used
          in: query
          name: referenceDate
          required: false
          schema:
            example: 2020-12-31
            format: date
            type: string
        - description: |-
            Select which `leaveType` will be returned. Based on the provided 'leaveType.key'(s)

            If not provided, the `leaveType` 16 (Verlof) is returned (16 is the sum of leaveType 1 (bovenwettelijk verlof) and 15 (wettelijk verlof))
          in: query
          name: leaveType
          required: false
          schema:
            items:
              example:
                - 1
                - 15
                - 99
              type: integer
            type: array
        - 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: Select the groupBy
          in: query
          name: groupBy
          required: true
          schema:
            enum:
              - Department
              - Function
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          groups:
                            description: Returns the total sum of a leave type for all employments in the given group by
                            items:
                              properties:
                                accrual:
                                  description: |
                                    The amount of leave units accrued for the leave type in the year
                                  example: 30
                                  format: double
                                  nullable: false
                                  pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                  readOnly: true
                                  type: number
                                balance:
                                  description: |
                                    The remaining leave balance for the year and leave type. The balance takes into account the leave usage in the future.
                                  example: 40
                                  format: double
                                  nullable: false
                                  pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                  readOnly: true
                                  type: number
                                balancePreviousYear:
                                  description: |
                                    The remaining leave balance from the previous year for the leave type
                                  example: 20
                                  format: double
                                  nullable: false
                                  pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                  readOnly: true
                                  type: number
                                group:
                                  properties:
                                    description:
                                      description: |
                                        The description of the groupBy, either the department or function
                                      example: Verkoop Binnendienst
                                      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
                                leaveType:
                                  description: |-
                                    The type of leave requested by the employee
                                    `leaveType` is a metadata field within the employer context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: false
                                  properties:
                                    balanceExceedsYear:
                                      description: |
                                        Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                                      example: true
                                      nullable: false
                                      readOnly: true
                                      type: boolean
                                    key:
                                      description: |
                                        The key for the leave type.
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    value:
                                      description: |
                                        The description for the leave type. Note that leave types can be overridden at the employer level. In these cases the description at the employer level takes precedence over the default description of the leave type.
                                      example: Verlof (bovenwettelijk)
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                usageAfterReferenceDate:
                                  description: |
                                    The amount of leave units used for the leave type in the year after `referenceDate`
                                  example: 2
                                  format: double
                                  minimum: 0
                                  nullable: false
                                  pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                  readOnly: true
                                  type: number
                                usageThroughReferenceDate:
                                  description: |
                                    The amount of leave units used for the leave type starting from the beginning of the year up to and `referenceDate` 
                                  example: 8
                                  format: double
                                  nullable: false
                                  pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                  readOnly: true
                                  type: number
                                usageTotal:
                                  description: |
                                    The total amount of leave units used for the leave type in the year.
                                  example: 10
                                  format: double
                                  nullable: false
                                  pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                  readOnly: true
                                  type: number
                                year:
                                  description: |
                                    The year to which the balance of the leave type applies.
                                  example: 2019
                                  format: int32
                                  maximum: 9999
                                  minimum: 2000
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              type: object
                            type: array
                          totals:
                            description: "Returns the total sum of a leave type for all employments          "
                            items:
                              properties:
                                accrual:
                                  description: |
                                    The amount of leave units accrued for the leave type in the year
                                  example: 30
                                  format: double
                                  nullable: false
                                  pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                  readOnly: true
                                  type: number
                                balance:
                                  description: |
                                    The remaining leave balance for the year and leave type. The balance takes into account the leave usage in the future.
                                  example: 40
                                  format: double
                                  nullable: false
                                  pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                  readOnly: true
                                  type: number
                                balancePreviousYear:
                                  description: |
                                    The remaining leave balance from the previous year for the leave type
                                  example: 20
                                  format: double
                                  nullable: false
                                  pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                  readOnly: true
                                  type: number
                                leaveType:
                                  description: |-
                                    The type of leave requested by the employee
                                    `leaveType` is a metadata field within the employer context. Possible values can be managed by the user.
                                  format: metadata
                                  nullable: false
                                  properties:
                                    balanceExceedsYear:
                                      description: |
                                        Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                                      example: true
                                      nullable: false
                                      readOnly: true
                                      type: boolean
                                    key:
                                      description: |
                                        The key for the leave type.
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: true
                                      type: integer
                                    value:
                                      description: |
                                        The description for the leave type. Note that leave types can be overridden at the employer level. In these cases the description at the employer level takes precedence over the default description of the leave type.
                                      example: Verlof (bovenwettelijk)
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                usageAfterReferenceDate:
                                  description: |
                                    The amount of leave units used for the leave type in the year after `referenceDate`
                                  example: 2
                                  format: double
                                  minimum: 0
                                  nullable: false
                                  pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                  readOnly: true
                                  type: number
                                usageThroughReferenceDate:
                                  description: |
                                    The amount of leave units used for the leave type starting from the beginning of the year up to and `referenceDate` 
                                  example: 8
                                  format: double
                                  nullable: false
                                  pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                  readOnly: true
                                  type: number
                                usageTotal:
                                  description: |
                                    The total amount of leave units used for the leave type in the year.
                                  example: 10
                                  format: double
                                  nullable: false
                                  pattern: ^-?(0|([1-9][0-9]*))(\.\d{1,2})?$
                                  readOnly: true
                                  type: number
                                year:
                                  description: |
                                    The year to which the balance of the leave type applies.
                                  example: 2019
                                  format: int32
                                  maximum: 9999
                                  minimum: 2000
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Summed up leave balance total and grouped by
      tags:
        - Leave balance
  "/providers/employers/{employerId}/leavetypes":
    get:
      description: |
        __Activity name :__ GetLeaveTypesByEmployerId

        Get a list of all leavetypes for the employer
      operationId: GetLeaveTypesByEmployerId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 employer
          in: path
          name: employerId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            deviations:
                              description: |-
                                Optional deviations to the leave type.

                                If set these deviations will overwrite the default values.

                                Note: Two leaveTypes are excluded from deviations "verlof" and "Verlof bovenwettelijk"
                              nullable: true
                              properties:
                                balanceExceedsYear:
                                  description: |
                                    Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                employeeCanRequestIncrease:
                                  description: |
                                    Indicates whether an employee can request an increase of leave via a leave request.
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                enabled:
                                  description: |
                                    Indicates whether the leave type can be used to book leave requests or leave.  This influences only new records. Old records using this leave type will remain and show the corresponding information.
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                value:
                                  description: |
                                    The description for the leave type.
                                  example: Verlof
                                  maxLength: 50
                                  nullable: false
                                  readOnly: false
                                  type: string
                              readOnly: false
                              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
                            leaveType:
                              description: |-
                                The default configuration of the leave type

                                If the deviations object is set those values overwrite all the default values.
                              format: metadata
                              nullable: false
                              properties:
                                balanceExceedsYear:
                                  description: |
                                    Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                                  example: true
                                  nullable: false
                                  readOnly: true
                                  type: boolean
                                employeeCanRequestIncrease:
                                  description: |
                                    Indicates whether an employee can request an increase of leave via a leave request.
                                  example: true
                                  nullable: false
                                  readOnly: true
                                  type: boolean
                                enabled:
                                  description: |
                                    Indicates whether the leave type can be used in leave requests or leave records. 
                                    This influences only new records. Old records using this leave type will remain and show the corresponding information.
                                  example: true
                                  nullable: false
                                  readOnly: true
                                  type: boolean
                                key:
                                  description: |
                                    The key for the leave type. This value is used in the `leaveType` metadata object to refer to this configuration (and the posible deviations)
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  description: |
                                    The description for the leave type.
                                  example: Verlof (bovenwettelijk)
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 leave types
      tags:
        - Leave types
  "/providers/employers/{employerId}/leavetypes/{leaveTypeId}":
    get:
      description: |
        __Activity name:__ GetLeaveTypeByEmployerIdAndLeaveTypeId

        Get the details of a leave type
      operationId: GetLeaveTypeByEmployerIdAndLeaveTypeId
      parameters:
        - description: The unique identifier of the leave type
          in: path
          name: leaveTypeId
          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 <TOKEN>
            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: employerId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          deviations:
                            description: |-
                              Optional deviations to the leave type.

                              If set these deviations will overwrite the default values.

                              Note: Two leaveTypes are excluded from deviations "verlof" and "Verlof bovenwettelijk"
                            nullable: true
                            properties:
                              balanceExceedsYear:
                                description: |
                                  Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                              employeeCanRequestIncrease:
                                description: |
                                  Indicates whether an employee can request an increase of leave via a leave request.
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              enabled:
                                description: |
                                  Indicates whether the leave type can be used to book leave requests or leave.  This influences only new records. Old records using this leave type will remain and show the corresponding information.
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                              value:
                                description: |
                                  The description for the leave type.
                                example: Verlof
                                maxLength: 50
                                nullable: false
                                readOnly: false
                                type: string
                            readOnly: false
                            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
                          leaveType:
                            description: |-
                              The default configuration of the leave type

                              If the deviations object is set those values overwrite all the default values.
                            format: metadata
                            nullable: false
                            properties:
                              balanceExceedsYear:
                                description: |
                                  Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                                example: true
                                nullable: false
                                readOnly: true
                                type: boolean
                              employeeCanRequestIncrease:
                                description: |
                                  Indicates whether an employee can request an increase of leave via a leave request.
                                example: true
                                nullable: false
                                readOnly: true
                                type: boolean
                              enabled:
                                description: |
                                  Indicates whether the leave type can be used in leave requests or leave records. 
                                  This influences only new records. Old records using this leave type will remain and show the corresponding information.
                                example: true
                                nullable: false
                                readOnly: true
                                type: boolean
                              key:
                                description: |
                                  The key for the leave type. This value is used in the `leaveType` metadata object to refer to this configuration (and the posible deviations)
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                description: |
                                  The description for the leave type.
                                example: Verlof (bovenwettelijk)
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 leave type
      tags:
        - Leave types
    put:
      description: |
        __Activity name:__ PutLeaveTypeByEmployerIdAndLeaveTypeId

        Edit the details for a leave type

        __Metadata :__ There is no metadata endpoint for this resource.
      operationId: PutLeaveTypeByEmployerIdAndLeaveTypeId
      parameters:
        - description: The unique identifier of the leave type
          in: path
          name: leaveTypeId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
        - description: Automatically added
          in: path
          name: employerId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                deviations:
                  description: |-
                    Optional deviations to the leave type.

                    If set these deviations will overwrite the default values.

                    Note: Two leaveTypes are excluded from deviations "verlof" and "Verlof bovenwettelijk"
                  nullable: true
                  properties:
                    balanceExceedsYear:
                      description: |
                        Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                      example: true
                      nullable: false
                      readOnly: false
                      type: boolean
                    employeeCanRequestIncrease:
                      description: |
                        Indicates whether an employee can request an increase of leave via a leave request.
                      example: false
                      nullable: false
                      readOnly: false
                      type: boolean
                    enabled:
                      description: |
                        Indicates whether the leave type can be used to book leave requests or leave.  This influences only new records. Old records using this leave type will remain and show the corresponding information.
                      example: true
                      nullable: false
                      readOnly: false
                      type: boolean
                    value:
                      description: |
                        The description for the leave type.
                      example: Verlof
                      maxLength: 50
                      nullable: false
                      readOnly: false
                      type: string
                  readOnly: false
                  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
                leaveType:
                  description: |-
                    The default configuration of the leave type

                    If the deviations object is set those values overwrite all the default values.
                  format: metadata
                  nullable: false
                  properties:
                    balanceExceedsYear:
                      description: |
                        Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                      example: true
                      nullable: false
                      readOnly: true
                      type: boolean
                    employeeCanRequestIncrease:
                      description: |
                        Indicates whether an employee can request an increase of leave via a leave request.
                      example: true
                      nullable: false
                      readOnly: true
                      type: boolean
                    enabled:
                      description: |
                        Indicates whether the leave type can be used in leave requests or leave records. 
                        This influences only new records. Old records using this leave type will remain and show the corresponding information.
                      example: true
                      nullable: false
                      readOnly: true
                      type: boolean
                    key:
                      description: |
                        The key for the leave type. This value is used in the `leaveType` metadata object to refer to this configuration (and the posible deviations)
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    value:
                      description: |
                        The description for the leave type.
                      example: Verlof (bovenwettelijk)
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
        description: Leave type 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          deviations:
                            description: |-
                              Optional deviations to the leave type.

                              If set these deviations will overwrite the default values.

                              Note: Two leaveTypes are excluded from deviations "verlof" and "Verlof bovenwettelijk"
                            nullable: true
                            properties:
                              balanceExceedsYear:
                                description: |
                                  Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                              employeeCanRequestIncrease:
                                description: |
                                  Indicates whether an employee can request an increase of leave via a leave request.
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              enabled:
                                description: |
                                  Indicates whether the leave type can be used to book leave requests or leave.  This influences only new records. Old records using this leave type will remain and show the corresponding information.
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                              value:
                                description: |
                                  The description for the leave type.
                                example: Verlof
                                maxLength: 50
                                nullable: false
                                readOnly: false
                                type: string
                            readOnly: false
                            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
                          leaveType:
                            description: |-
                              The default configuration of the leave type

                              If the deviations object is set those values overwrite all the default values.
                            format: metadata
                            nullable: false
                            properties:
                              balanceExceedsYear:
                                description: |
                                  Indicates whether the balance at the end of the year for this leave type carries over to the next year.
                                example: true
                                nullable: false
                                readOnly: true
                                type: boolean
                              employeeCanRequestIncrease:
                                description: |
                                  Indicates whether an employee can request an increase of leave via a leave request.
                                example: true
                                nullable: false
                                readOnly: true
                                type: boolean
                              enabled:
                                description: |
                                  Indicates whether the leave type can be used in leave requests or leave records. 
                                  This influences only new records. Old records using this leave type will remain and show the corresponding information.
                                example: true
                                nullable: false
                                readOnly: true
                                type: boolean
                              key:
                                description: |
                                  The key for the leave type. This value is used in the `leaveType` metadata object to refer to this configuration (and the posible deviations)
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                description: |
                                  The description for the leave type.
                                example: Verlof (bovenwettelijk)
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a leave type
      tags:
        - Leave types
  "/providers/employers/{employerId}/logo":
    delete:
      description: |
        __Activity name:__ DeleteEmployerLogoByEmployerId

        Delete the logo of an employer
      operationId: DeleteEmployerLogoByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employer logo
      tags:
        - Employer
    get:
      description: |
        __Activity name :__ GetEmployerLogoByEmployerId

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

        __Caching:__ This resource changes very infrequently and can be cached for a longer period.

        Get the logo of the employer. In case no logo is know the service will return a 404.
      operationId: GetEmployerLogoByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: Logo of an employer
      tags:
        - Employer
    post:
      description: |
        __Activity name :__ PostEmployerLogoByEmployerId

        Upload a logo for the employer.
      operationId: PostEmployerLogoByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                data:
                  description: base64 encoded document file.
                  example: YQ==
                  nullable: false
                  readOnly: false
                  type: string
                mimeType:
                  description: The mimetype of the data.
                  example: image/jpeg
                  nullable: false
                  readOnly: false
                  type: string
        description: Logo to be uploaded for the employer.
        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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 logo for the employer
      tags:
        - Employer
  "/providers/employers/{employerId}/logo/{version}":
    get:
      description: |
        __Activity name :__ GetEmployerLogoByEmployerId

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

        __Caching:__ This resource changes very infrequently and can be cached for a longer period.

        Get the logo of the employer. In case no logo is know the service will return a 404.
      operationId: GetEmployerLogoByEmployerIdAndVersion
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: An optional guid generated for caching. The value does not influence the output of this function. The Employer resource returns the URI of the current logo.
          in: path
          name: version
          required: true
          schema:
            format: uuid
            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: Logo of an employer
      tags:
        - Employer
  "/providers/employers/{employerId}/modules":
    get:
      description: |
        __Activity name :__ GetModulesByEmployerId

        Get the array of the modules enabled for the specified employer. A module enables a certain functionality for the given employer. These are typically called 'producten' in Loket.
      operationId: GetModulesByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            description:
                              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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 modules enabled for the employer
      tags:
        - Modules
  "/providers/employers/{employerId}/nationalholidays":
    get:
      description: |
        __Activity name :__ GetNationalHolidaysByEmployerId

        Get a list of all national holidays for the employer
      operationId: GetNationalHolidaysByEmployerId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 employer
          in: path
          name: employerId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            deviations:
                              description: |-
                                Optional deviations to the national holiday.
                                If set these deviations will overwrite the default values.
                              nullable: true
                              properties:
                                enabled:
                                  description: |
                                    Indicates whether the national holiday is used to calculate leave hours for a leave request.  This influences only new records. Old records using this national holiday will remain and show the corresponding information.
                                  example: true
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                value:
                                  description: |
                                    The description for the national holiday.
                                  example: Boxing day
                                  maxLength: 50
                                  nullable: false
                                  readOnly: false
                                  type: string
                              readOnly: false
                              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
                            nationalHoliday:
                              description: |-
                                The default configuration of the national holiday.

                                If the deviations object is set those values overwrite all the default values.
                              format: metadata
                              nullable: false
                              properties:
                                dateInCurrentYear:
                                  description: |
                                    The date for the national holiday in the current year.
                                  example: 2021-12-26
                                  format: date
                                  nullable: true
                                  readOnly: true
                                  type: string
                                enabled:
                                  description: |
                                    Indicates whether the national holiday is used to calculate leave hours for a leave request
                                  example: true
                                  nullable: false
                                  readOnly: true
                                  type: boolean
                                key:
                                  description: |
                                    The key for the national holiday. This value is used in the `nationalHoliday` metadata object to refer to this configuration (and the posible deviations)
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  description: |
                                    The description for the national holiday.
                                  example: 2e kerstdag
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 national holidays
      tags:
        - National holiday
  "/providers/employers/{employerId}/nationalholidays/{nationalHolidayId}":
    get:
      description: |
        __Activity name:__ GetNationalHolidaysByEmployerIdAndNationalHolidayId

        Get the details of a national holiday
      operationId: GetNationalHolidaysByEmployerIdAndNationalHolidayId
      parameters:
        - description: The unique identifier of the national holiday
          in: path
          name: nationalHolidayId
          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 <TOKEN>
            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: employerId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          deviations:
                            description: |-
                              Optional deviations to the national holiday.
                              If set these deviations will overwrite the default values.
                            nullable: true
                            properties:
                              enabled:
                                description: |
                                  Indicates whether the national holiday is used to calculate leave hours for a leave request.  This influences only new records. Old records using this national holiday will remain and show the corresponding information.
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                              value:
                                description: |
                                  The description for the national holiday.
                                example: Boxing day
                                maxLength: 50
                                nullable: false
                                readOnly: false
                                type: string
                            readOnly: false
                            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
                          nationalHoliday:
                            description: |-
                              The default configuration of the national holiday.

                              If the deviations object is set those values overwrite all the default values.
                            format: metadata
                            nullable: false
                            properties:
                              dateInCurrentYear:
                                description: |
                                  The date for the national holiday in the current year.
                                example: 2021-12-26
                                format: date
                                nullable: true
                                readOnly: true
                                type: string
                              enabled:
                                description: |
                                  Indicates whether the national holiday is used to calculate leave hours for a leave request
                                example: true
                                nullable: false
                                readOnly: true
                                type: boolean
                              key:
                                description: |
                                  The key for the national holiday. This value is used in the `nationalHoliday` metadata object to refer to this configuration (and the posible deviations)
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                description: |
                                  The description for the national holiday.
                                example: 2e kerstdag
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 national holiday
      tags:
        - National holiday
    put:
      description: |
        __Activity name:__ PutNationalHolidayByEmployerIdAndNationalHolidayId

        Edit the details for a national holiday

        __Metadata :__ There is no metadata endpoint for this resource.
      operationId: PutNationalHolidayByEmployerIdAndNationalHolidayId
      parameters:
        - description: The unique identifier of the national holiday
          in: path
          name: nationalHolidayId
          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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
        - description: Automatically added
          in: path
          name: employerId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              properties:
                deviations:
                  description: |-
                    Optional deviations to the national holiday.
                    If set these deviations will overwrite the default values.
                  nullable: true
                  properties:
                    enabled:
                      description: |
                        Indicates whether the national holiday is used to calculate leave hours for a leave request.  This influences only new records. Old records using this national holiday will remain and show the corresponding information.
                      example: true
                      nullable: false
                      readOnly: false
                      type: boolean
                    value:
                      description: |
                        The description for the national holiday.
                      example: Boxing day
                      maxLength: 50
                      nullable: false
                      readOnly: false
                      type: string
                  readOnly: false
                  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
                nationalHoliday:
                  description: |-
                    The default configuration of the national holiday.

                    If the deviations object is set those values overwrite all the default values.
                  format: metadata
                  nullable: false
                  properties:
                    dateInCurrentYear:
                      description: |
                        The date for the national holiday in the current year.
                      example: 2021-12-26
                      format: date
                      nullable: true
                      readOnly: true
                      type: string
                    enabled:
                      description: |
                        Indicates whether the national holiday is used to calculate leave hours for a leave request
                      example: true
                      nullable: false
                      readOnly: true
                      type: boolean
                    key:
                      description: |
                        The key for the national holiday. This value is used in the `nationalHoliday` metadata object to refer to this configuration (and the posible deviations)
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: true
                      type: integer
                    value:
                      description: |
                        The description for the national holiday.
                      example: 2e kerstdag
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
        description: National holiday 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          deviations:
                            description: |-
                              Optional deviations to the national holiday.
                              If set these deviations will overwrite the default values.
                            nullable: true
                            properties:
                              enabled:
                                description: |
                                  Indicates whether the national holiday is used to calculate leave hours for a leave request.  This influences only new records. Old records using this national holiday will remain and show the corresponding information.
                                example: true
                                nullable: false
                                readOnly: false
                                type: boolean
                              value:
                                description: |
                                  The description for the national holiday.
                                example: Boxing day
                                maxLength: 50
                                nullable: false
                                readOnly: false
                                type: string
                            readOnly: false
                            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
                          nationalHoliday:
                            description: |-
                              The default configuration of the national holiday.

                              If the deviations object is set those values overwrite all the default values.
                            format: metadata
                            nullable: false
                            properties:
                              dateInCurrentYear:
                                description: |
                                  The date for the national holiday in the current year.
                                example: 2021-12-26
                                format: date
                                nullable: true
                                readOnly: true
                                type: string
                              enabled:
                                description: |
                                  Indicates whether the national holiday is used to calculate leave hours for a leave request
                                example: true
                                nullable: false
                                readOnly: true
                                type: boolean
                              key:
                                description: |
                                  The key for the national holiday. This value is used in the `nationalHoliday` metadata object to refer to this configuration (and the posible deviations)
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                description: |
                                  The description for the national holiday.
                                example: 2e kerstdag
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of a national holidays
      tags:
        - National holiday
  "/providers/employers/{employerId}/notes":
    get:
      description: |
        __Activity name :__ GetEmployerNotesByEmployerId

        Get a list of notes, available for the user, for the employer. 
      operationId: GetEmployerNotesByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            accessibleBy:
                              description: |
                                Indicates who can view this node.
                              nullable: false
                              properties:
                                key:
                                  description: The key for accessible by
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: Description of the accessible by
                                  example: Everyone
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            createdBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            createdOn:
                              description: |
                                The date on which the note was created
                              example: 2018-01-01
                              format: date-time
                              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
                            lastModifiedBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            lastModifiedOn:
                              description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                              example: 2018-01-01
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            note:
                              description: |-
                                The note it self.

                                __Note:__ This is a free text field so users can add htlm/script etc.
                              example: Remember to do xyz
                              maxLength: 4000
                              nullable: true
                              readOnly: false
                              type: string
                            subject:
                              description: subject of the note
                              example: Remember to do xyz
                              maxLength: 250
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 notes for an employer.
      tags:
        - Employer notes
    post:
      description: |
        __Activity name :__ PostEmployerNoteByEmployerId

        __Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.

        __Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostEmployerNoteByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                accessibleBy:
                  description: |
                    Indicates who can view this node.
                  nullable: false
                  properties:
                    key:
                      description: The key for accessible by
                      example: 1
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      description: Description of the accessible by
                      example: Everyone
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                createdBy:
                  format: metadata
                  nullable: true
                  properties:
                    formattedName:
                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                createdOn:
                  description: |
                    The date on which the note was created
                  example: 2018-01-01
                  format: date-time
                  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
                lastModifiedBy:
                  format: metadata
                  nullable: true
                  properties:
                    formattedName:
                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                lastModifiedOn:
                  description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                  example: 2018-01-01
                  format: date-time
                  nullable: false
                  readOnly: true
                  type: string
                note:
                  description: |-
                    The note it self.

                    __Note:__ This is a free text field so users can add htlm/script etc.
                  example: Remember to do xyz
                  maxLength: 4000
                  nullable: true
                  readOnly: false
                  type: string
                subject:
                  description: subject of the note
                  example: Remember to do xyz
                  maxLength: 250
                  nullable: false
                  readOnly: false
                  type: string
              type: object
        description: Add a note
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          accessibleBy:
                            description: |
                              Indicates who can view this node.
                            nullable: false
                            properties:
                              key:
                                description: The key for accessible by
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: Description of the accessible by
                                example: Everyone
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          createdBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          createdOn:
                            description: |
                              The date on which the note was created
                            example: 2018-01-01
                            format: date-time
                            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
                          lastModifiedBy:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          lastModifiedOn:
                            description: The date on which the note was last modified (this field has the same value as `createdOn` if no change was made afther creation).
                            example: 2018-01-01
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          note:
                            description: |-
                              The note it self.

                              __Note:__ This is a free text field so users can add htlm/script etc.
                            example: Remember to do xyz
                            maxLength: 4000
                            nullable: true
                            readOnly: false
                            type: string
                          subject:
                            description: subject of the note
                            example: Remember to do xyz
                            maxLength: 250
                            nullable: false
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 note for an employer
      tags:
        - Employer notes
  "/providers/employers/{employerId}/notifications":
    get:
      description: |
        __Activity name :__ GetNotificationsByEmployerId

        Get a list of unread notifications for an employer
      operationId: GetNotificationsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            appliesToEmployee:
                              format: metadata
                              nullable: false
                              properties:
                                dateOfBirth:
                                  description: |
                                    The date of birth
                                  example: 1995-05-21
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                employeeNumber:
                                  description: The employee number to uniquely identify a employee within a 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
                                lastNamePartner:
                                  description: The last name of the partner of the employee
                                  example: Wiel
                                  maxLength: 25
                                  nullable: true
                                  readOnly: true
                                  type: string
                                photo:
                                  description: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                                  example: https://api.loket.nl/v2/providers/employers/employees/{employeeId}/photo/{version}
                                  format: url
                                  nullable: true
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the employee
                                  example: van
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                                prefixPartner:
                                  description: The prefix of the partner of the employee
                                  example: van de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              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
                            isRead:
                              description: Indicates whether the notification has been read
                              example: false
                              nullable: false
                              readOnly: false
                              type: boolean
                            markedAsReadBy:
                              format: metadata
                              nullable: true
                              properties:
                                formattedName:
                                  description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            markedAsReadOn:
                              description: The time at which the notificiation was marked as read.
                              example: 2018-02-05T12:29:44+02:00
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            notificationDate:
                              description: The date on which the event of the notificationType (e.g. birthday or anniversary) will occure
                              example: 2018-02-05
                              format: date
                              nullable: false
                              readOnly: true
                              type: string
                            notificationType:
                              description: The type of notification
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: Verjaardag
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            notificationTypeClarification:
                              description: Optional text
                              example: 30 Jaar
                              maxLength: 150
                              nullable: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 notifications for an employer.
      tags:
        - Notification
  "/providers/employers/{employerId}/payrolladministrations":
    get:
      description: |
        __Activity name :__ GetPayrollAdministrationsByEmployerId

        Get a list of all payroll administrations for an employer
      operationId: GetPayrollAdministrationsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          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
                            administrationNumber:
                              description: The administration number is a free field commonly used to register the debtors number.
                              example: ABC
                              maxLength: 15
                              nullable: true
                              readOnly: false
                              type: string
                            cao:
                              description: The CAO (CLA -> collective labor agrement) of the "loonmodel" the payroll administration is linked to.
                              format: metadata
                              properties:
                                key:
                                  example: 184
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Agriculture
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            claTaxReturnCBSCode:
                              description: |
                                The CBS code of the CLA (NL: CAO nummer), which is used for payroll tax return purposes.  If no CLA is applicable than is field may be filled with value 9999. Please also note that this value might be empty (this is not recommended but it's possible).
                              example: 1896
                              format: int32
                              nullable: true
                              readOnly: false
                              type: integer
                            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
                            contact:
                              nullable: true
                              properties:
                                name:
                                  description: Name of the contact of the administration
                                  example: Henk de Vries
                                  maxLength: 50
                                  nullable: true
                                  readOnly: false
                                  type: string
                                phoneNumber:
                                  description: The general phone number of the administration
                                  example: 013-12345678
                                  maxLength: 15
                                  nullable: true
                                  readOnly: false
                                  type: string
                              readOnly: false
                              type: object
                            description:
                              description: Description of the administration
                              example: Bakker
                              maxLength: 50
                              nullable: false
                              readOnly: false
                              type: string
                            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
                            endDate:
                              description: |
                                The last day the payroll administration is active.
                              example: 2020-12-31
                              format: date
                              nullable: true
                              readOnly: false
                              type: string
                            groupClassification:
                              description: |-
                                The group classification for the payroll administration. This field is used for filtering and grouping within the interface.

                                `groupClassification` is a metadata field within the provider context. Possible values can be managed by the user.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  example: 3
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: South
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            groupCode:
                              description: Number (integer) used for grouping administrations.
                              example: 40
                              format: int32
                              nullable: false
                              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
                            loonmodel:
                              description: |-
                                The "loonmodel" (this is a loket.nl term) the payroll administration inherits the payrolling configuration from. Deviating from the loonmodel configuration on payrol administration level is posible.

                                `loonmodel` is a metadata field within the provider context. Possible values can be managed by the user.
                              format: metadata
                              properties:
                                key:
                                  example: 184
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Foresting monthly payrolling
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            name:
                              description: Name of the administration
                              example: ABC accountants
                              maxLength: 70
                              nullable: false
                              readOnly: false
                              type: string
                            payrollPeriodType:
                              description: Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4).
                              nullable: false
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: month
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            payrollTaxesNumber:
                              description: The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst.
                              example: 111111110L46
                              maxLength: 12
                              minLength: 12
                              nullable: true
                              readOnly: false
                              type: string
                            shortName:
                              description: Shortened name of the administration
                              example: ABC acc
                              maxLength: 12
                              nullable: true
                              readOnly: false
                              type: string
                            startDate:
                              description: |
                                The first day the payroll administration is active.
                              example: 2016-01-01
                              format: date
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 payroll administrations for an employer
      tags:
        - Payroll administration
  "/providers/employers/{employerId}/proforma":
    get:
      description: |
        __Activity name :__ GetProformaStatusByEmployerId

        Get the status of proforma for this employer
      operationId: GetProformaStatusByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          activeFor:
                            format: metadata
                            nullable: true
                            properties:
                              formattedName:
                                description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          status:
                            enum:
                              - Inactive
                              - Data transfer in progress
                              - Active
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the status of proforma for this employer
      tags:
        - Proforma
  "/providers/employers/{employerId}/proforma/initialize":
    post:
      description: |
        __Activity name:__ PostInitializeProformaByEmployerId

        Initialize a proforma environment (request the copying of data from live to proforma).

        __Metadata :__ None

        __Defaults :__ None
      operationId: PostInitializeProformaByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                employeeId:
                  description: |-
                    If this Id is set all the employment of the specific employee will be copied to the proforma environment otherwise all employments are copied.

                    Does not work in combination with `proformaType` = "Zonder dienstverbanden"
                  example: 904d6856-6034-4624-bcbc-886188c115c5
                  format: uuid
                  nullable: true
                  readOnly: false
                  type: string
                proformaType:
                  enum:
                    - WithSalaryResultsWithSalaryVariables
                    - WithSalaryResultsWithoutSalaryVariables
                    - WithoutSalaryResultsWithSalaryVariables
                    - WithoutSalaryResultsWithoutSalaryVariables
                    - WithoutEmployments
                  type: string
              type: object
        required: true
      responses:
        "202":
          description: Accepted
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Initialize the proforma environment
      tags:
        - Proforma
  "/providers/employers/{employerId}/providerlogo":
    get:
      description: |-
        __Activity name :__ GetProviderLogoByEmployerId

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

        Get the (deviating) provider logo of the employers. In case no logo is know the service will return a 404.

        __Caching:__ This resource changes very infrequently and can be cached for a longer time.
      operationId: GetProviderLogoByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                description: A binary string representation of the image.
                example: 0X123dlkfhjowildjhflkdsjfglkjsdfjldsj3iou540923ingms
                format: binary
                type: string
            image/jpg:
              schema:
                description: A binary string representation of the image.
                example: 0X123dlkfhjowildjhflkdsjfglkjsdfjldsj3iou540923ingms
                format: binary
                type: string
            image/png:
              schema:
                description: A binary string representation of the image.
                example: 0X123dlkfhjowildjhflkdsjfglkjsdfjldsj3iou540923ingms
                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: Provider logo
      tags:
        - Employer
  "/providers/employers/{employerId}/providerlogo/{version}":
    get:
      description: |-
        __Activity name :__ GetProviderLogoByEmployerId

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

        Get the (deviating) provider logo of the employers. In case no logo is know the service will return a 404.

        __Caching:__ This resource changes very infrequently and can be cached for a longer time.
      operationId: GetProviderLogoByEmployerIdAndVersion
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: An optional guid generated for caching. The value does not influence the output of this function. The Employer resource returns the URI of the current logo.
          in: path
          name: version
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          content:
            image/jpeg:
              schema:
                description: A binary string representation of the image.
                format: binary
                type: string
            image/jpg:
              schema:
                description: A binary string representation of the image.
                format: binary
                type: string
            image/png:
              schema:
                description: A binary string representation of the image.
                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: Provider logo
      tags:
        - Employer
  "/providers/employers/{employerId}/useraccessibledepartments":
    get:
      description: |
        __Activity name :__ GetUserAccessibleDepartmentsByEmployerId

        Get a list of all departments for the employer, which are accesible for the current user. 
      operationId: GetUserAccessibleDepartmentsByEmployerId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 employer
          in: path
          name: employerId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            code:
                              description: |
                                The visible identifier of the department.
                              example: 2
                              format: int32
                              nullable: false
                              readOnly: false
                              type: integer
                            description:
                              description: |
                                The visible description (i.e. name) of the department.
                              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)
                              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.
                              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)
                                  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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 user accessible departments
      tags:
        - Departments
  "/providers/employers/{employerId}/users":
    get:
      description: |
        __Activity name :__ GetEmployerUsersByEmployerId


         Get the list of users of the employer
      operationId: GetEmployerUsersByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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=SSO_gebruiker:
              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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            accessStatus:
                              description: indicates the access status of the user.
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 3
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: Has access to Client
                                  maxLength: 255
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            azureActiveDirectory:
                              nullable: true
                              properties:
                                tenant:
                                  description: The Azure AD tennant
                                  format: metadata
                                  properties:
                                    description:
                                      example: Customer X Azure AD
                                      maxLength: 100
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    id:
                                      description: Id for the tennant
                                      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
                                    tenantRegistrationLevel:
                                      enum:
                                        - provider
                                        - employer
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                userId:
                                  description: The userId as known in the Azure AD of the selected tennant
                                  example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                  nullable: false
                                  readOnly: false
                                  type: string
                              type: object
                            contactInformation:
                              nullable: false
                              properties:
                                emailAddress:
                                  description: The e-mail address of the user.
                                  example: info@loket.nl
                                  maxLength: 255
                                  nullable: false
                                  pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                  readOnly: false
                                  type: string
                                phoneNumber:
                                  description: The phone number of the user.
                                  example: +31 13-1234567
                                  maxLength: 15
                                  minLength: 1
                                  nullable: true
                                  readOnly: false
                                  type: string
                                placeOfEmployment:
                                  description: The place of employment (standplaats) for the user.
                                  example: Amsterdam office
                                  maxLength: 24
                                  minLength: 1
                                  nullable: true
                                  readOnly: false
                                  type: string
                              type: object
                            dateTimeCreation:
                              description: The date on which the user was created
                              example: 2020-01-19
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            dateTimeLastLogin:
                              description: The date on which the user loged in for the last time
                              example: 2021-01-19
                              format: date-time
                              nullable: true
                              readOnly: true
                              type: string
                            hasAccessToPayrollingTestData:
                              description: Indicates if the user has access to data for payrolling test years
                              example: false
                              nullable: false
                              readOnly: false
                              type: boolean
                            hasIntegrations:
                              description: Indicates if the user has integrations with clients other that Loket
                              example: false
                              nullable: false
                              readOnly: true
                              type: boolean
                            hasMultiFactorAuthentication:
                              description: |-
                                Indicates if the user has multi factor authentication enabled

                                Can only be changed from true to false.
                              example: false
                              nullable: false
                              readOnly: false
                              type: boolean
                            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
                            isDepartmentManager:
                              description: Indicates if the user is a department manager
                              example: false
                              nullable: false
                              readOnly: true
                              type: boolean
                            isLinkedToMultipleEmployers:
                              description: Indicates if the user has access to multiple employer.
                              example: false
                              nullable: false
                              readOnly: true
                              type: boolean
                            loginMethod:
                              description: The allowedlogin method for the user
                              format: metadata
                              properties:
                                key:
                                  example: 3
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Only via SSO
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            personalDetails:
                              properties:
                                firstName:
                                  description: The first name of the user
                                  example: Susan
                                  maxLength: 28
                                  minLength: 1
                                  nullable: true
                                  readOnly: false
                                  type: string
                                initials:
                                  description: The initials of the user
                                  example: S.L.
                                  maxLength: 6
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Bergen
                                  maxLength: 25
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: van
                                  maxLength: 10
                                  minLength: 1
                                  nullable: true
                                  readOnly: false
                                  type: string
                              type: object
                            twoFactorAuthenticationRequired:
                              description: "Indicates whether two factor authentication is required for the user. This setting is only available for login method: Via website en SSO "
                              example: false
                              nullable: false
                              readOnly: false
                              type: boolean
                            userCustomSpecifiedRole:
                              description: |
                                Further specification of the user role.
                              example: Secretariaat medewerker
                              maxLength: 50
                              nullable: true
                              readOnly: false
                              type: string
                            userName:
                              description: The username
                              example: User42
                              maxLength: 50
                              minLength: 3
                              nullable: true
                              readOnly: true
                              type: string
                            userSpecifiedRole:
                              description: The Role which the user has specified.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  example: 3
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: Salarisadministrateur
                                  maxLength: 50
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 users for an employer
      tags:
        - Employer user
    post:
      description: |
        __Activity name :__ PostEmployerUserByEmployerId

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL. 

        Add an SSO or Azure AD user for an employer. 
      operationId: PostEmployerUserByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                azureActiveDirectory:
                  nullable: true
                  properties:
                    externalUserId:
                      description: The userId as known in the Azure AD of the selected tennant
                      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
                    tenantId:
                      description: Id for the tennant
                      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
                    userName:
                      example: User123
                      maxLength: 50
                      minLength: 3
                      nullable: false
                      readOnly: false
                      type: string
                  type: object
                contactInformation:
                  nullable: false
                  properties:
                    emailAddress:
                      description: The e-mail address of the user.
                      example: info@loket.nl
                      maxLength: 255
                      nullable: false
                      pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                      readOnly: false
                      type: string
                    phoneNumber:
                      description: The phone number of the user.
                      example: +31 13-1234567
                      maxLength: 15
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                    placeOfEmployment:
                      description: The place of employment (standplaats) for the user.
                      example: Amsterdam office
                      maxLength: 24
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                  type: object
                hasAccessToPayrollingTestData:
                  description: Indicates if the user has access to data for payrolling test years
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                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
                loginMethod:
                  description: The allowedlogin method for the user
                  format: metadata
                  properties:
                    key:
                      example: 3
                      format: int32
                      nullable: false
                      readOnly: false
                      type: integer
                    value:
                      example: Only via SSO
                      maxLength: 50
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                personalDetails:
                  properties:
                    initials:
                      description: The initials of the user
                      example: S.L.
                      maxLength: 6
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Bergen
                      maxLength: 25
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: van
                      maxLength: 10
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                  type: object
                ssoAccount:
                  nullable: true
                  properties:
                    password:
                      description: The password
                      example: Password%6
                      maxLength: 255
                      minLength: 8
                      nullable: false
                      pattern: (?=^.{8,255}$)((?=.*\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[^A-Za-z0-9])(?=.*[a-z])|(?=.*[^A-Za-z0-9])(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9]))^.*
                      readOnly: false
                      type: string
                    userName:
                      example: Customer X Azure AD
                      maxLength: 50
                      minLength: 3
                      nullable: false
                      readOnly: false
                      type: string
                  type: object
              type: object
        description: Add a user for an employer.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          accessStatus:
                            description: indicates the access status of the user.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 3
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Has access to Client
                                maxLength: 255
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          azureActiveDirectory:
                            nullable: true
                            properties:
                              tenant:
                                description: The Azure AD tennant
                                format: metadata
                                properties:
                                  description:
                                    example: Customer X Azure AD
                                    maxLength: 100
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  id:
                                    description: Id for the tennant
                                    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
                                  tenantRegistrationLevel:
                                    enum:
                                      - provider
                                      - employer
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              userId:
                                description: The userId as known in the Azure AD of the selected tennant
                                example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                nullable: false
                                readOnly: false
                                type: string
                            type: object
                          contactInformation:
                            nullable: false
                            properties:
                              emailAddress:
                                description: The e-mail address of the user.
                                example: info@loket.nl
                                maxLength: 255
                                nullable: false
                                pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                readOnly: false
                                type: string
                              phoneNumber:
                                description: The phone number of the user.
                                example: +31 13-1234567
                                maxLength: 15
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              placeOfEmployment:
                                description: The place of employment (standplaats) for the user.
                                example: Amsterdam office
                                maxLength: 24
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                            type: object
                          dateTimeCreation:
                            description: The date on which the user was created
                            example: 2020-01-19
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          dateTimeLastLogin:
                            description: The date on which the user loged in for the last time
                            example: 2021-01-19
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          hasAccessToPayrollingTestData:
                            description: Indicates if the user has access to data for payrolling test years
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          hasIntegrations:
                            description: Indicates if the user has integrations with clients other that Loket
                            example: false
                            nullable: false
                            readOnly: true
                            type: boolean
                          hasMultiFactorAuthentication:
                            description: |-
                              Indicates if the user has multi factor authentication enabled

                              Can only be changed from true to false.
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          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
                          isDepartmentManager:
                            description: Indicates if the user is a department manager
                            example: false
                            nullable: false
                            readOnly: true
                            type: boolean
                          isLinkedToMultipleEmployers:
                            description: Indicates if the user has access to multiple employer.
                            example: false
                            nullable: false
                            readOnly: true
                            type: boolean
                          loginMethod:
                            description: The allowedlogin method for the user
                            format: metadata
                            properties:
                              key:
                                example: 3
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Only via SSO
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          personalDetails:
                            properties:
                              firstName:
                                description: The first name of the user
                                example: Susan
                                maxLength: 28
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              initials:
                                description: The initials of the user
                                example: S.L.
                                maxLength: 6
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Bergen
                                maxLength: 25
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: van
                                maxLength: 10
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                            type: object
                          twoFactorAuthenticationRequired:
                            description: "Indicates whether two factor authentication is required for the user. This setting is only available for login method: Via website en SSO "
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          userCustomSpecifiedRole:
                            description: |
                              Further specification of the user role.
                            example: Secretariaat medewerker
                            maxLength: 50
                            nullable: true
                            readOnly: false
                            type: string
                          userName:
                            description: The username
                            example: User42
                            maxLength: 50
                            minLength: 3
                            nullable: true
                            readOnly: true
                            type: string
                          userSpecifiedRole:
                            description: The Role which the user has specified.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 3
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Salarisadministrateur
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 SSO or Azure AD user for an employer
      tags:
        - Employer user
  "/providers/employers/{employerId}/users/departments":
    get:
      description: |
        __Activity name:__ GetEmployerUsersLinkedDepartmentsByEmployerId

        Get the list of departments that the user has access to
      operationId: GetEmployerUsersLinkedDepartmentsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: false
                          properties:
                            departments:
                              items:
                                properties:
                                  code:
                                    description: |
                                      The visible identifier of the department.
                                    example: 2
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  description:
                                    description: |
                                      The visible description (i.e. name) of the department.            
                                    example: Verkoop Binnendienst
                                    maxLength: 50
                                    nullable: false
                                    readOnly: false
                                    type: string
                                  hasAccessToSubDepartments:
                                    description: Indicates whether the user will have access to departments that are configured as sub-departments of the selected department.
                                    example: false
                                    nullable: true
                                    readOnly: true
                                    type: boolean
                                  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
                            personalDetails:
                              properties:
                                firstName:
                                  description: The first name of the user
                                  example: Susan
                                  maxLength: 28
                                  minLength: 1
                                  nullable: true
                                  readOnly: false
                                  type: string
                                initials:
                                  description: The initials of the user
                                  example: S.L.
                                  maxLength: 6
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Bergen
                                  maxLength: 25
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: van
                                  maxLength: 10
                                  minLength: 1
                                  nullable: true
                                  readOnly: false
                                  type: string
                              type: object
                            userId:
                              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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 the list of departments that the user has access to
      tags:
        - Linked departments
  "/providers/employers/{employerId}/users/invite":
    post:
      description: |
        __Activity name :__ PostInviteEmployerUserByEmployerId

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired via /providers/employers/{employerId}/users/metadata

        __Defaults :__ Default values for a new object can be acquired by via /providers/employers/{employerId}/users/defaults

        Send an invite to an user for an employer. 
      operationId: PostInviteEmployerUserByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                contactInformation:
                  nullable: false
                  properties:
                    emailAddress:
                      description: The e-mail address of the user.
                      example: info@loket.nl
                      maxLength: 255
                      nullable: false
                      pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                      readOnly: false
                      type: string
                    phoneNumber:
                      description: The phone number of the user.
                      example: +31 13-1234567
                      maxLength: 15
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                    placeOfEmployment:
                      description: The place of employment (standplaats) for the user.
                      example: Amsterdam office
                      maxLength: 24
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                  type: object
                destinationForSecret:
                  description: The destination phonenumber to sent the secret to during registration.
                  example: "0612345678"
                  maxLength: 15
                  minLength: 3
                  nullable: false
                  readOnly: false
                  type: string
                hasAccessToPayrollingTestData:
                  description: Indicates if the user has access to data for payrolling test years
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
                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:
                  properties:
                    initials:
                      description: The initials of the user
                      example: S.L.
                      maxLength: 6
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Bergen
                      maxLength: 25
                      minLength: 1
                      nullable: false
                      readOnly: false
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: van
                      maxLength: 10
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                  type: object
                twoFactorAuthenticationRequired:
                  description: "Indicates whether two factor authentication is required for the user. This setting is only available for login method: Via website en SSO "
                  example: false
                  nullable: false
                  readOnly: false
                  type: boolean
              type: object
        description: Add a user for an employer.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          accessStatus:
                            description: indicates the access status of the user.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                example: 3
                                format: int32
                                nullable: false
                                readOnly: true
                                type: integer
                              value:
                                example: Has access to Client
                                maxLength: 255
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          azureActiveDirectory:
                            nullable: true
                            properties:
                              tenant:
                                description: The Azure AD tennant
                                format: metadata
                                properties:
                                  description:
                                    example: Customer X Azure AD
                                    maxLength: 100
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  id:
                                    description: Id for the tennant
                                    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
                                  tenantRegistrationLevel:
                                    enum:
                                      - provider
                                      - employer
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                              userId:
                                description: The userId as known in the Azure AD of the selected tennant
                                example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                nullable: false
                                readOnly: false
                                type: string
                            type: object
                          contactInformation:
                            nullable: false
                            properties:
                              emailAddress:
                                description: The e-mail address of the user.
                                example: info@loket.nl
                                maxLength: 255
                                nullable: false
                                pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                readOnly: false
                                type: string
                              phoneNumber:
                                description: The phone number of the user.
                                example: +31 13-1234567
                                maxLength: 15
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              placeOfEmployment:
                                description: The place of employment (standplaats) for the user.
                                example: Amsterdam office
                                maxLength: 24
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                            type: object
                          dateTimeCreation:
                            description: The date on which the user was created
                            example: 2020-01-19
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          dateTimeLastLogin:
                            description: The date on which the user loged in for the last time
                            example: 2021-01-19
                            format: date-time
                            nullable: true
                            readOnly: true
                            type: string
                          hasAccessToPayrollingTestData:
                            description: Indicates if the user has access to data for payrolling test years
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          hasIntegrations:
                            description: Indicates if the user has integrations with clients other that Loket
                            example: false
                            nullable: false
                            readOnly: true
                            type: boolean
                          hasMultiFactorAuthentication:
                            description: |-
                              Indicates if the user has multi factor authentication enabled

                              Can only be changed from true to false.
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          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
                          isDepartmentManager:
                            description: Indicates if the user is a department manager
                            example: false
                            nullable: false
                            readOnly: true
                            type: boolean
                          isLinkedToMultipleEmployers:
                            description: Indicates if the user has access to multiple employer.
                            example: false
                            nullable: false
                            readOnly: true
                            type: boolean
                          loginMethod:
                            description: The allowedlogin method for the user
                            format: metadata
                            properties:
                              key:
                                example: 3
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Only via SSO
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          personalDetails:
                            properties:
                              firstName:
                                description: The first name of the user
                                example: Susan
                                maxLength: 28
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              initials:
                                description: The initials of the user
                                example: S.L.
                                maxLength: 6
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Bergen
                                maxLength: 25
                                minLength: 1
                                nullable: false
                                readOnly: false
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: van
                                maxLength: 10
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                            type: object
                          twoFactorAuthenticationRequired:
                            description: "Indicates whether two factor authentication is required for the user. This setting is only available for login method: Via website en SSO "
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          userCustomSpecifiedRole:
                            description: |
                              Further specification of the user role.
                            example: Secretariaat medewerker
                            maxLength: 50
                            nullable: true
                            readOnly: false
                            type: string
                          userName:
                            description: The username
                            example: User42
                            maxLength: 50
                            minLength: 3
                            nullable: true
                            readOnly: true
                            type: string
                          userSpecifiedRole:
                            description: The Role which the user has specified.
                            format: metadata
                            nullable: true
                            properties:
                              key:
                                example: 3
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Salarisadministrateur
                                maxLength: 50
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Send an invite for an employer user
      tags:
        - Employer user
  "/providers/employers/{employerId}/users/link":
    post:
      description: |
        __Activity name :__ PostLinkExistingUserByEmployerId

        __Metadata :__  No metadata endpoint

        __Defaults :__ No default values 

        Link an existing employer user to this employer. 
      operationId: PostLinkExistingUserByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                departments:
                  items:
                    description: id of a department
                    example: 904d6856-6034-4624-bcbc-886188c115c5
                    format: uuid
                    nullable: false
                    readOnly: false
                    type: string
                  nullable: true
                  type: array
                userId:
                  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: Link an existing user to this employer.
        required: true
      responses:
        "202":
          description: Accepted
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Link an existing employer user to this employer.
      tags:
        - Employer user
  "/providers/employers/{employerId}/users/{userId}/authorizations":
    get:
      description: |
        __Activity name :__ GetEmployerUserAuthorizationsByEmployerIdAndUserId 


         List the available authorizations for the user - employer combination. Note that the employer user can have a different set of authorizations per employer.


         =============== This endpoint is not yet available ===============
      operationId: GetEmployerUserAuthorizationsByEmployerIdAndUserId
      parameters:
        - description: The unique identifier of an employer
          in: path
          name: employerId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of an user
          in: path
          name: userId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          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
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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: The authorizations for the user
      tags:
        - Employer user authorizations
    patch:
      description: |
        __Activity name :__ PatchEmployerUserAuthorizationsByUserId

        Manage the employer user authorizations and `authorizationSet`.


        Only the changes supplied are processed existing records not supplied in the request body will be left unchanged.  e.g. If three authorizations are enabled for the user and a patch is performed with in the body one new authorization with the `isEnabled` = true. The result will be that the user has 4 enabled authorizations.
      operationId: PatchEmployerUserAuthorizationsByUserId
      parameters:
        - description: The unique identifier of an employer
          in: path
          name: employerId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of an user
          in: path
          name: userId
          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 <TOKEN>
            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:
                authorizationSet:
                  format: metadata
                  properties:
                    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: false
                      type: string
                  type: object
                  writeOnly: true
                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
              type: object
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Manage the employer user authorizations
      tags:
        - Employer user authorizations
  "/providers/employers/{employerId}/users/{userId}/departments":
    patch:
      description: |
        __Activity name:__ PatchEmployerUserLinkedDepartmentsByEmployerIdAndUserId

        This endpoint enables the user to link or unlink multiple 'linkages' with one call.
      operationId: PatchEmployerUserLinkedDepartmentsByEmployerIdAndUserId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of an user
          in: path
          name: userId
          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 <TOKEN>
            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.
                    enum:
                      - link
                      - unlink
                    nullable: false
                    readOnly: false
                    type: string
                  departmentId:
                    description: The unique identifier (GUID/UUID) of the department
                    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
                  hasAccessToSubDepartments:
                    description: Indicates whether the user will have access to departments that are configured as sub-departments of the selected department.
                    example: false
                    nullable: false
                    readOnly: false
                    type: boolean
              type: array
        description: The request body
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Link or unlink departments from an user.
      tags:
        - Linked departments
  "/providers/employers/{employerId}/workflows":
    get:
      description: |
        __Activity name:__ GetWorkflowsByEmployerId
            

        Get the list of all workflows for an employer. All as in both open as finished workflows are returned.
      operationId: GetWorkflowsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: true
                          properties:
                            allowedTransitions:
                              description: |-
                                In this object the posible transitions are returned.
                                By sending a request to the `href` with the given `httpVerb` and one of the options given in `transitions` in the body. The workflow is transitioned to the given state.
                              items:
                                properties:
                                  description:
                                    description: The description of the transition (task)
                                    example: Controleer de vergoedingen
                                    maxLength: 256
                                    nullable: true
                                    readOnly: true
                                    type: string
                                  href:
                                    example: https://api.loket.nl/v2/providers/employers/workflows/{workflowId}/transition
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  httpVerb:
                                    enum:
                                      - POST
                                      - PATCH
                                      - PUT
                                    format: enum
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  transitions:
                                    example:
                                      - action: fabf3b25-abf9-4e8c-a8f7-81400d1b0e96
                                        description: Approve
                                      - action: abc31d45-f593-4d73-8078-6caba9cebdcc
                                        description: Reject
                                    items:
                                      properties:
                                        action:
                                          description: The unique identifier for the action to be taken
                                          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
                                        description:
                                          description: Description of the action
                                          example: Approve
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      type: object
                                    nullable: false
                                    readOnly: true
                                    type: array
                                type: object
                              nullable: true
                              readOnly: true
                              type: array
                            assignee:
                              description: A workflow is either assigned to a user or a role. A role can be filled by multiple users.
                              nullable: true
                              properties:
                                role:
                                  format: metadata
                                  nullable: true
                                  properties:
                                    description:
                                      description: A description of the role.
                                      example: Employer
                                      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
                                  type: object
                                user:
                                  format: metadata
                                  nullable: true
                                  properties:
                                    formattedName:
                                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                      example: Jong, I
                                      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
                                    initials:
                                      description: The initials of the user
                                      example: I
                                      maxLength: 6
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    lastName:
                                      description: The last name of the user
                                      example: Jong
                                      maxLength: 25
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    prefix:
                                      description: The prefix of the user
                                      example: de
                                      maxLength: 10
                                      nullable: true
                                      readOnly: true
                                      type: string
                                  type: object
                              type: object
                            data:
                              description: A JSON representation of the mutation/data regarding this workflow
                              example:
                                address:
                                  city: Leiden
                                  country:
                                    key: 1
                                  houseNumber: 12
                                  houseNumberAddition: D
                                  postalCode: 1234 AA
                                  street: Voordijk
                              format: JSON
                              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
                            initiatedBy:
                              format: metadata
                              nullable: false
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            initiatedOn:
                              example: 2019-11-23T11:14:06Z
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            lastModifiedBy:
                              format: metadata
                              nullable: false
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            lastModifiedOn:
                              description: date and time on which the last modification on the workflow was performed. This can be either by the system or a user.
                              example: 2019-11-23T11:14:06Z
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            status:
                              description: Indicates the status of the workflow as a whole.
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: The unique identifier
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: In progress
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              type: object
                            trigger:
                              description: |-
                                Indicates the trigger that started the workflow.

                                `trigger` is a metadata field within the employer context. Possible values can be managed by the user. 
                              format: metadata
                              nullable: false
                              properties:
                                description:
                                  example: Address change for employee
                                  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
                              readOnly: true
                              type: object
                            workflowTemplate:
                              description: |-
                                Indicates what workflow template was used to initiate the workflow.

                                `workflowTemplate` is a metadata field within the employer context. Possible values can be managed by the user. 
                              format: metadata
                              nullable: false
                              properties:
                                description:
                                  example: Approval by employer
                                  maxLength: 256
                                  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
                                version:
                                  description: The version of the workflow template this workflow was based on. Changes to a workflow template do not affect existing workflows.
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Workflows for the employer
      tags:
        - Workflows
  "/providers/employers/{employerId}/workflowtriggermappings":
    get:
      description: |
        __Activity name:__ GetWorkflowTriggerMappingsByEmployerId
            

        Get the list workflow triggers that are mapped to a workflowTemplate.  Workflow triggers are triggers that trigger a workflow. With this resource one can manage which trigger will trigger what workflow.
      operationId: GetWorkflowTriggerMappingsByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: true
                          properties:
                            createdBy:
                              format: metadata
                              nullable: false
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            createdOn:
                              example: 2019-11-23T11:14:06Z
                              format: date-time
                              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
                            lastModifiedBy:
                              format: metadata
                              nullable: false
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            lastModifiedOn:
                              example: 2019-11-23T11:14:06Z
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            trigger:
                              description: |-
                                Indicates the workflow trigger to be configured.

                                `trigger` is a metadata field within the employer context. Possible values can be managed by the user. 
                              format: metadata
                              nullable: false
                              properties:
                                description:
                                  example: Address change for employee
                                  maxLength: 256
                                  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
                              type: object
                            workflowTemplate:
                              description: |-
                                Indicates what workflow template will be used to initiate a workflow when the trigger takes place.

                                `workflowTemplate` is a metadata field within the employer context. Possible values can be managed by the user. 
                              format: metadata
                              nullable: false
                              properties:
                                description:
                                  example: Approval by employer
                                  maxLength: 256
                                  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
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Workflowtrigger to workflowtemplate mapping
      tags:
        - Workflow trigger mapping
    post:
      description: |
        __Activity name:__ PostWorkflowTriggerMappingByEmployerId
            

        Create a workflow trigger mapping record for an employer

        __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.
      operationId: PostWorkflowTriggerMappingByEmployerId
      parameters:
        - description: The unique identifier of the employer
          in: path
          name: employerId
          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 <TOKEN>
            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:
                createdBy:
                  format: metadata
                  nullable: false
                  properties:
                    formattedName:
                      description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                createdOn:
                  example: 2019-11-23T11:14:06Z
                  format: date-time
                  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
                lastModifiedBy:
                  format: metadata
                  nullable: false
                  properties:
                    formattedName:
                      description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                      example: Jong, I
                      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 user
                      example: I
                      maxLength: 6
                      nullable: false
                      readOnly: true
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Jong
                      maxLength: 25
                      nullable: false
                      readOnly: true
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: de
                      maxLength: 10
                      nullable: true
                      readOnly: true
                      type: string
                  readOnly: true
                  type: object
                lastModifiedOn:
                  example: 2019-11-23T11:14:06Z
                  format: date-time
                  nullable: false
                  readOnly: true
                  type: string
                trigger:
                  description: |-
                    Indicates the workflow trigger to be configured.

                    `trigger` is a metadata field within the employer context. Possible values can be managed by the user. 
                  format: metadata
                  nullable: false
                  properties:
                    description:
                      example: Address change for employee
                      maxLength: 256
                      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
                  type: object
                workflowTemplate:
                  description: |-
                    Indicates what workflow template will be used to initiate a workflow when the trigger takes place.

                    `workflowTemplate` is a metadata field within the employer context. Possible values can be managed by the user. 
                  format: metadata
                  nullable: false
                  properties:
                    description:
                      example: Approval by employer
                      maxLength: 256
                      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
                  type: object
              type: object
        description: Workflow triggers record to add to the employer.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          createdBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          createdOn:
                            example: 2019-11-23T11:14:06Z
                            format: date-time
                            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
                          lastModifiedBy:
                            format: metadata
                            nullable: false
                            properties:
                              formattedName:
                                description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                example: Jong, I
                                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 user
                                example: I
                                maxLength: 6
                                nullable: false
                                readOnly: true
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Jong
                                maxLength: 25
                                nullable: false
                                readOnly: true
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: de
                                maxLength: 10
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          lastModifiedOn:
                            example: 2019-11-23T11:14:06Z
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          trigger:
                            description: |-
                              Indicates the workflow trigger to be configured.

                              `trigger` is a metadata field within the employer context. Possible values can be managed by the user. 
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Address change for employee
                                maxLength: 256
                                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
                            type: object
                          workflowTemplate:
                            description: |-
                              Indicates what workflow template will be used to initiate a workflow when the trigger takes place.

                              `workflowTemplate` is a metadata field within the employer context. Possible values can be managed by the user. 
                            format: metadata
                            nullable: false
                            properties:
                              description:
                                example: Approval by employer
                                maxLength: 256
                                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
                            type: object
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 workflow trigger mapping record for an employer
      tags:
        - Workflow trigger mapping
  "/providers/leavePolicies/{leavePolicyId}":
    get:
      description: |-
        __Activity name :__ GetProviderLeavePolicyByLeavePolicyId

        Returns one leave policy
      operationId: GetProviderLeavePolicyByLeavePolicyId
      parameters:
        - description: The unique identifier of the leave policy
          in: path
          name: leavePolicyId
          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 <TOKEN>
            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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          accrualType:
                            description: "Indicates how leave is accrued (yearly, monthly or hourly)  "
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The key for the `accrualType`
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the `accrualType`
                                example: Jaar
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          additionalLeave:
                            nullable: false
                            properties:
                              allocationType:
                                description: Indicates how additional leave is to be assigned to the employments (linked to this leave policy).
                                format: metadata
                                nullable: false
                                properties:
                                  key:
                                    description: |
                                      The key for the `additionalLeaveAllocationType`
                                    example: 1
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    description: |
                                      The description for the `additionalLeaveAllocationType`
                                    example: Boek alleen hoogste waarde
                                    nullable: false
                                    readOnly: true
                                    type: string
                                readOnly: false
                                type: object
                              referenceDate1:
                                description: If `referenceDate2` has a value only the last 6 months of the year are allowed as values
                                nullable: false
                                properties:
                                  day:
                                    description: The day of the first reference date.
                                    example: 40
                                    format: int32
                                    maximum: 31
                                    minimum: 1
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  month:
                                    description: "The month of the first reference date "
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        description: |
                                          The key for the `referenceMonth`
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        description: |
                                          The description for the `referenceMonth`
                                        example: Januari
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    readOnly: false
                                    type: object
                                type: object
                              referenceDate2:
                                description: Only use if applicable
                                nullable: true
                                properties:
                                  day:
                                    description: The day of the second reference date.
                                    example: 40
                                    format: int32
                                    maximum: 31
                                    minimum: 1
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  month:
                                    description: "The month of the second reference date "
                                    format: metadata
                                    nullable: false
                                    properties:
                                      key:
                                        description: |
                                          The key for the `referenceMonth`
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        description: |
                                          The description for the `referenceMonth`
                                        example: Januari
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    readOnly: false
                                    type: object
                                type: object
                            readOnly: false
                            type: object
                          dayOfTheMonthToPerformAutomaticLeaveCalculationOn:
                            description: |-
                              They day of the month on which the automatic accrual of (yearly or monthly) leave is performed. The yearly calculation is repeated every month to encompase any changes made that have affect on the past.
                              If for example 31 is chosen and a specific month does not have that day the logic will pick the first available date of said month.          
                            example: 12
                            format: int32
                            maximum: 31
                            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
                          leaveEntitlement:
                            nullable: true
                            properties:
                              excessLeaveToStatutory:
                                description: The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                              statutory:
                                description: The statutory leave (wetelijk verlof) linked employments are entitled to for a full time contract.
                                example: 160
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                              wtr:
                                description: The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                example: 40
                                format: double
                                maximum: 999.99
                                minimum: 0.01
                                nullable: true
                                pattern: ^(\d{1,3})(.\d{1,2})?$
                                readOnly: false
                                type: number
                            readOnly: false
                            type: object
                          leaveRequest:
                            nullable: false
                            properties:
                              applyLeaveSchedule:
                                description: Indicates whether the leave schedule can be enterd and is so it is used when calculating the sugested leave hours for a leave request
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                              leavePattern:
                                description: |
                                  The applicable leave pattern for a period of 2 weeks can be stored in this object. Each field contains the number of leave(work) hours for that day in the 2-week period. <br /> Please note that the `leavePattern` should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                                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
                              useHolidaysInCalculation:
                                description: |-
                                  Indicates whether the calculating for sugested leave hours for a leave request takes into account holidays. Is set to true no leave hours are calculated for "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."

                                  eg. When requesting leave for the 24th and 25th of december (25th being a national holiday) the calculation (8 hours a day) will return 8 when `useHolidaysInCalculation` is true and 16 when `useHolidaysInCalculation` is false
                                example: false
                                nullable: false
                                readOnly: false
                                type: boolean
                            readOnly: false
                            type: object
                          leaveUnitType:
                            description: Indicates what the unit type (hours or days) is. Employments linked to this leave policy use this leaveUnitType for their leave.
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The key for the unit type
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the leave unit type
                                example: Uren
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          name:
                            description: The name of the leave policy
                            example: Normal leave
                            maxLength: 50
                            minLength: 1
                            nullable: false
                            readOnly: false
                            type: string
                          payoutLeaveImmediately:
                            description: If leave `accrualType` is set to based on hours worked (uren) then this field allows for the leave hours to be paid out directly instead of being accrued.
                            example: false
                            nullable: false
                            readOnly: false
                            type: boolean
                          roundTo:
                            description: Indicates to how many digits after the decimal point to round the numbers
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The key for the roundTo
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the roundTo
                                example: "0.01"
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            type: object
                          roundingMethod:
                            description: "Indicates how to round the numbers "
                            format: metadata
                            nullable: false
                            properties:
                              key:
                                description: |
                                  The key for the roundingMethod
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                description: |
                                  The description for the roundingMethod
                                example: Logical
                                nullable: false
                                readOnly: true
                                type: string
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: A single leave policy
      tags:
        - Provider leave policy
  "/providers/leavePolicies/{leavePolicyId}/agebasedleave":
    get:
      description: |
        __Activity name :__ GetProviderAgeBasedLeaveByLeavePolicyId <br/>  <br/>  Returns the age based leave for the given leave policy at provider level.
      operationId: GetProviderAgeBasedLeaveByLeavePolicyId
      parameters:
        - description: The unique identifier of the leave policy
          in: path
          name: leavePolicyId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            from:
                              nullable: false
                              properties:
                                numberOfMonths:
                                  description: the number of months of age to be applicable for the additional leave
                                  example: 0
                                  format: int32
                                  maximum: 11
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                numberOfYears:
                                  description: the employee's minimal age to be applicable for the additional leave
                                  example: 40
                                  format: int32
                                  maximum: 999
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              readOnly: false
                              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
                            leaveEntitlement:
                              nullable: false
                              properties:
                                excessLeaveToStatutory:
                                  description: |-
                                    The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.

                                    Either excessLeaveToStatutory or wtr must have a value
                                  example: 40
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,3})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                wtr:
                                  description: |-
                                    The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                                  

                                    Either excessLeaveToStatutory or wtr must have a value                
                                  example: 40
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,3})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                              readOnly: false
                              type: object
                            upToAndIncluding:
                              properties:
                                numberOfMonths:
                                  description: the number of months of age to be applicable for the additional leave
                                  example: 11
                                  format: int32
                                  maximum: 11
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                numberOfYears:
                                  description: the employee's minimal age to be applicable for the additional leave
                                  example: 50
                                  format: int32
                                  maximum: 999
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Age based leave
      tags:
        - Provider leave policy
  "/providers/leavePolicies/{leavePolicyId}/wagebasedleave":
    get:
      description: |
        __Activity name :__ GetProviderWageBasedLeaveByLeavePolicyId <br/>  <br/>  Returns the wage based leave for the given leave policy at provider level.
      operationId: GetProviderWageBasedLeaveByLeavePolicyId
      parameters:
        - description: The unique identifier of the leave policy
          in: path
          name: leavePolicyId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            fromWage:
                              description: the from wage the employment has to earn to be applicable for the additional leave
                              example: 40
                              format: double
                              maximum: 99999999999999.98
                              minimum: 0
                              nullable: false
                              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
                            leaveEntitlement:
                              nullable: false
                              properties:
                                excessLeaveToStatutory:
                                  description: |-
                                    The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.
                                                  

                                    Either excessLeaveToStatutory or wtr must have a value
                                  example: 40
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,14})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                wtr:
                                  description: |-
                                    The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                                  

                                    Either excessLeaveToStatutory or wtr must have a value
                                  example: 40
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,3})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                              readOnly: false
                              type: object
                            upToAndIncludingWage:
                              description: the up to and including wage the employment has to earn to be applicable for the additional leave
                              example: 40
                              format: double
                              maximum: 99999999999999.98
                              minimum: 0
                              nullable: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Wage based leave
      tags:
        - Provider leave policy
  "/providers/leavePolicies/{leavePolicyId}/yearsofservicebasedleave":
    get:
      description: |
        __Activity name :__ GetProviderYearsOfServiceBasedLeaveByLeavePolicyId <br/>  <br/>  Returns the years of service based leave for the given leave policy at providerlevel.
      operationId: GetProviderYearsOfServiceBasedLeaveByLeavePolicyId
      parameters:
        - description: The unique identifier of the leave policy
          in: path
          name: leavePolicyId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            from:
                              properties:
                                numberOfMonths:
                                  description: the number of months of service to be applicable for the additional leave
                                  example: 0
                                  format: int32
                                  maximum: 11
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                numberOfYears:
                                  description: the number of years of service to be applicable for the additional leave
                                  example: 40
                                  format: int32
                                  maximum: 999
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              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
                            leaveEntitlement:
                              nullable: false
                              properties:
                                excessLeaveToStatutory:
                                  description: |-
                                    The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.

                                    Either excessLeaveToStatutory or wtr must have a value
                                  example: 40
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,3})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                wtr:
                                  description: |-
                                    The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.

                                    Either excessLeaveToStatutory or wtr must have a value
                                  example: 40
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,3})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                              readOnly: false
                              type: object
                            upToAndIncluding:
                              properties:
                                numberOfMonths:
                                  description: the number of months of service to be applicable for the additional leave
                                  example: 0
                                  format: int32
                                  maximum: 11
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                numberOfYears:
                                  description: the number of years of service to be applicable for the additional leave
                                  example: 40
                                  format: int32
                                  maximum: 999
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: years of service based leave
      tags:
        - Provider leave policy
  "/providers/notificationsets/{notificationSetId}":
    get:
      description: |
        __Activity name :__ GetNotificationSetByNotificationSetId 


         Details of an notification set. 
      operationId: GetNotificationSetByNotificationSetId
      parameters:
        - description: The unique identifier of an notification set
          in: path
          name: notificationSetId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          description:
                            example: Salarisadministrateur
                            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
                          notifications:
                            items:
                              properties:
                                createNumberOfDaysBeforeEvent:
                                  description: The number of days that the notification is created befor the event takes place.
                                  example: 30
                                  format: int32
                                  maximum: 99
                                  minimum: 0
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                isEnabled:
                                  description: Enable or disable a notification for a user
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                notificationType:
                                  description: The notification set
                                  format: metadata
                                  nullable: true
                                  properties:
                                    key:
                                      example: 3
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      example: Start of employment
                                      maxLength: 70
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  type: object
                                receiveDepartmentSignalsOnly:
                                  description: |-
                                    Only receive notification for your departments.
                                    Not relevant if the user is not a department manager.
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                sendMailWhenNotificationIsCreated:
                                  description: send an email when on creation of the notification
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                            type: array
                          numberOfLinkedEmployerUsers:
                            description: The number of employer users that are linked to this notification set
                            example: 435
                            format: int32
                            nullable: false
                            readOnly: true
                            type: integer
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 notification set
      tags:
        - Notification sets
  "/providers/users/{providerUserId}/configuredexternaltenant":
    get:
      description: |
        __Activity name :__ GetConfiguredExternalTenantByProviderUserId


         Get the external tenant that is configured for this specific user. 
      operationId: GetConfiguredExternalTenantByProviderUserId
      parameters:
        - description: The unique identifier of a provider user
          in: path
          name: providerUserId
          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 <TOKEN>
            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
      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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          externalTenant:
                            nullable: true
                            properties:
                              id:
                                description: The unique identifier (GUID/UUID) of an external tenant.  Input validation; the value of this field MUST match one of the external tenants that is available to this user (check the GetExternalTenants call)
                                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: The user-friendly name of the external tenant
                                example: Loket tenant
                                maxLength: 28
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          externalUser:
                            nullable: true
                            properties:
                              id:
                                description: The unique identifier of an Azure AD user. The id of an user can be found in in Azure AD application. Within this endpoint there is no input validation for this value, but in order to succesfully perform the Azure AD login flow it must correspond with an actual user id within the provided external tenant.
                                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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Configured external tenant for a provider user
      tags:
        - External tenant provider user
    patch:
      description: |
        __Activity name :__ PatchConfiguredExternalTenantByProviderUserId

        __Metadata :__  N/A.

        __Defaults :__ N/A.

        Modify an external tenant to the list of an configured external tenants for an employer user.
        An configured external tenant may be removed by sending a request body with both an empty externalTenant object and an empty externalUser object.
      operationId: PatchConfiguredExternalTenantByProviderUserId
      parameters:
        - description: The unique identifier of a provider user
          in: path
          name: providerUserId
          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 <TOKEN>
            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: false
              properties:
                externalTenant:
                  nullable: true
                  properties:
                    id:
                      description: The unique identifier (GUID/UUID) of an external tenant.  Input validation; the value of this field MUST match one of the external tenants that is available to this user (check the GetExternalTenants call)
                      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: The user-friendly name of the external tenant
                      example: Loket tenant
                      maxLength: 28
                      nullable: false
                      readOnly: true
                      type: string
                  type: object
                externalUser:
                  nullable: true
                  properties:
                    id:
                      description: The unique identifier of an Azure AD user. The id of an user can be found in in Azure AD application. Within this endpoint there is no input validation for this value, but in order to succesfully perform the Azure AD login flow it must correspond with an actual user id within the provided external tenant.
                      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: Add an external tenant for a provider user.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          externalTenant:
                            nullable: true
                            properties:
                              id:
                                description: The unique identifier (GUID/UUID) of an external tenant.  Input validation; the value of this field MUST match one of the external tenants that is available to this user (check the GetExternalTenants call)
                                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: The user-friendly name of the external tenant
                                example: Loket tenant
                                maxLength: 28
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          externalUser:
                            nullable: true
                            properties:
                              id:
                                description: The unique identifier of an Azure AD user. The id of an user can be found in in Azure AD application. Within this endpoint there is no input validation for this value, but in order to succesfully perform the Azure AD login flow it must correspond with an actual user id within the provided external tenant.
                                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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 an external tenant for a provider user
      tags:
        - External tenant provider user
  "/providers/{providerId}/applicationsets":
    get:
      description: |
        __Activity name:__ GetApplicationsetsByProviderId
            

        Get the list of Applicationsets for a provider. 
      operationId: GetApplicationsetsByProviderId
      parameters:
        - description: The unique identifier of a provider
          in: path
          name: providerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: true
                          properties:
                            applicationSetType:
                              description: |
                                The type of the set 
                              enum:
                                - Products
                                - ExportDataTemplate
                                - Rights
                              nullable: false
                              readOnly: false
                              type: string
                            data:
                              description: |
                                Contains an array of objects in json structure.
                              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
                              example: Exportset Dienstverband
                              maximum: 50
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 applicationsets for a provider
      tags:
        - Applicationsets
    post:
      description: |
        __Activity name:__ PostApplicationSetByProviderId
            

        Create an applicationset for a provider.
      operationId: PostApplicationSetByProviderId
      parameters:
        - description: The unique identifier of a provider
          in: path
          name: providerId
          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 <TOKEN>
            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 
                  enum:
                    - Products
                    - ExportDataTemplate
                    - Rights
                  nullable: false
                  readOnly: false
                  type: string
                data:
                  description: |
                    Contains an array of objects in json structure.
                  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
                  example: Exportset Dienstverband
                  maximum: 50
                  nullable: false
                  readOnly: false
                  type: string
              type: object
        description: Applicationset to add to the provider.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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 
                            enum:
                              - Products
                              - ExportDataTemplate
                              - Rights
                            nullable: false
                            readOnly: false
                            type: string
                          data:
                            description: |
                              Contains an array of objects in json structure.
                            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
                            example: Exportset Dienstverband
                            maximum: 50
                            nullable: false
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 applicationset for a provider
      tags:
        - Applicationsets
  "/providers/{providerId}/authorizations":
    get:
      description: |
        __Activity name :__ GetAuthorizationsByProviderId




        Get the array of activities the user is authenticated for with regard to the specified provider. This endpoint is only accessible for providerusers.
      operationId: GetAuthorizationsByProviderId
      parameters:
        - description: The unique identifier of a provider
          in: path
          name: providerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            description:
                              example: GetJournalRunsByPayrollAdministrationId
                              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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 authorized activities with regard to the provider
      tags:
        - Authorizations
  "/providers/{providerId}/authorizationsets":
    get:
      description: |
        __Activity name :__ GetAuthorizationSetsByProviderId 


         List the available authorization sets. 
      operationId: GetAuthorizationSetsByProviderId
      parameters:
        - description: The unique identifier of a provider
          in: path
          name: providerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 authorization sets
      tags:
        - Authorization sets
  "/providers/{providerId}/billableitems":
    get:
      description: |
        __Activity name :__ GetBillableItemsByProviderId

        Get a list of all billable items for the provider. 
      operationId: GetBillableItemsByProviderId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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 a provider
          in: path
          name: providerId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            employer:
                              description: |
                                Data about the employer.
                              nullable: false
                              properties:
                                companyName:
                                  example: Janssen B.V.
                                  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
                            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
                            providerId:
                              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
                            requestedDate:
                              description: |
                                The date on which the billable item is requested.
                              example: 2022-04-12
                              format: date
                              nullable: false
                              readOnly: true
                              type: string
                            requestedItem:
                              description: |
                                Details on the requested item.
                              nullable: false
                              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
                                itemType:
                                  description: |
                                    Details on the requested item.
                                  nullable: false
                                  properties:
                                    description:
                                      description: The description of the item type.
                                      example: Preboarding traject
                                      nullable: false
                                      type: string
                                    itemType:
                                      description: The item type of the billed item.
                                      enum:
                                        - preboardingTrajectory
                                      nullable: false
                                      type: string
                                  type: object
                                preboardingTrajectory:
                                  description: |
                                    This object contains item type specific data
                                  nullable: true
                                  properties:
                                    dateLastModification:
                                      description: The date on which the status was last modified
                                      example: 2022-04-12
                                      format: date
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    status:
                                      description: |
                                        The status of the preboardingTraject.
                                      enum:
                                        - open
                                        - completed
                                        - endedPrematurely
                                      example: open
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: true
                                  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: 2018-12-31
                            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 <field>
                              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.
                                See [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 billable items
      tags:
        - Billable items
  "/providers/{providerId}/emailidentities":
    get:
      description: |
        __Activity name:__ GetEmailIdentitiesByProviderId
            

        Get the list of EmailIdentities for a provider. 
      operationId: GetEmailIdentitiesByProviderId
      parameters:
        - description: The unique identifier of a provider
          in: path
          name: providerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: true
                          properties:
                            dkimTokens:
                              items:
                                description: The Tokens which should be registred
                                example: u6deqmqhlgn3wxslcp4cugcz7ognh4gt
                                type: string
                              nullable: true
                              readOnly: true
                              type: array
                            emailIdentity:
                              description: The emailIdentity that can be used when sending email.
                              example: provider.com
                              nullable: false
                              readOnly: false
                              type: string
                            emailIdentityType:
                              description: The type of the set emailIdentity
                              enum:
                                - DOMAIN
                              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
                            isDkimVerified:
                              description: Indicates whether the EmailIdentity has passed Spf verfication.
                              example: true
                              nullable: false
                              readOnly: true
                              type: boolean
                            isSpfVerified:
                              description: Indicates whether the EmailIdentity has passed Spf verfication.
                              example: true
                              nullable: false
                              readOnly: true
                              type: boolean
                            lastDkimVerifiedOn:
                              description: The date the Dkim settings were last verified.
                              example: 2022-01-31
                              format: date
                              nullable: false
                              readOnly: true
                              type: string
                            lastSpfVerifiedOn:
                              description: The date the Spf settings were last verified.
                              example: 2022-01-31
                              format: date
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 EmailIdentities for a provider
      tags:
        - EmailIdentities
    post:
      description: |
        __Activity name:__ PostEmailIdentityByProviderId
            

        Create an EmailIdentity for a provider.
      operationId: PostEmailIdentityByProviderId
      parameters:
        - description: The unique identifier of a provider
          in: path
          name: providerId
          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 <TOKEN>
            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:
                dkimTokens:
                  items:
                    description: The Tokens which should be registred
                    example: u6deqmqhlgn3wxslcp4cugcz7ognh4gt
                    type: string
                  nullable: true
                  readOnly: true
                  type: array
                emailIdentity:
                  description: The emailIdentity that can be used when sending email.
                  example: provider.com
                  nullable: false
                  readOnly: false
                  type: string
                emailIdentityType:
                  description: The type of the set emailIdentity
                  enum:
                    - DOMAIN
                  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
                isDkimVerified:
                  description: Indicates whether the EmailIdentity has passed Spf verfication.
                  example: true
                  nullable: false
                  readOnly: true
                  type: boolean
                isSpfVerified:
                  description: Indicates whether the EmailIdentity has passed Spf verfication.
                  example: true
                  nullable: false
                  readOnly: true
                  type: boolean
                lastDkimVerifiedOn:
                  description: The date the Dkim settings were last verified.
                  example: 2022-01-31
                  format: date
                  nullable: false
                  readOnly: true
                  type: string
                lastSpfVerifiedOn:
                  description: The date the Spf settings were last verified.
                  example: 2022-01-31
                  format: date
                  nullable: false
                  readOnly: true
                  type: string
              type: object
        description: EmailIdentity to add to the provider.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          dkimTokens:
                            items:
                              description: The Tokens which should be registred
                              example: u6deqmqhlgn3wxslcp4cugcz7ognh4gt
                              type: string
                            nullable: true
                            readOnly: true
                            type: array
                          emailIdentity:
                            description: The emailIdentity that can be used when sending email.
                            example: provider.com
                            nullable: false
                            readOnly: false
                            type: string
                          emailIdentityType:
                            description: The type of the set emailIdentity
                            enum:
                              - DOMAIN
                            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
                          isDkimVerified:
                            description: Indicates whether the EmailIdentity has passed Spf verfication.
                            example: true
                            nullable: false
                            readOnly: true
                            type: boolean
                          isSpfVerified:
                            description: Indicates whether the EmailIdentity has passed Spf verfication.
                            example: true
                            nullable: false
                            readOnly: true
                            type: boolean
                          lastDkimVerifiedOn:
                            description: The date the Dkim settings were last verified.
                            example: 2022-01-31
                            format: date
                            nullable: false
                            readOnly: true
                            type: string
                          lastSpfVerifiedOn:
                            description: The date the Spf settings were last verified.
                            example: 2022-01-31
                            format: date
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 EmailIdentity for a provider
      tags:
        - EmailIdentities
  "/providers/{providerId}/emailidentities/verify":
    post:
      description: |
        __Activity name:__ PostVerifyEmailIdentityByProviderId
            

        Verify an EmailIdentity for a provider. The verficationstatus will we saved and used by Loket when sending email. 
      operationId: PostVerifyEmailIdentityByProviderId
      parameters:
        - description: The unique identifier of a provider
          in: path
          name: providerId
          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 <TOKEN>
            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:
                dkimTokens:
                  items:
                    description: The Tokens which should be registred
                    example: u6deqmqhlgn3wxslcp4cugcz7ognh4gt
                    type: string
                  nullable: true
                  readOnly: true
                  type: array
                emailIdentity:
                  description: The emailIdentity that can be used when sending email.
                  example: provider.com
                  nullable: false
                  readOnly: false
                  type: string
                emailIdentityType:
                  description: The type of the set emailIdentity
                  enum:
                    - DOMAIN
                  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
                isDkimVerified:
                  description: Indicates whether the EmailIdentity has passed Spf verfication.
                  example: true
                  nullable: false
                  readOnly: true
                  type: boolean
                isSpfVerified:
                  description: Indicates whether the EmailIdentity has passed Spf verfication.
                  example: true
                  nullable: false
                  readOnly: true
                  type: boolean
                lastDkimVerifiedOn:
                  description: The date the Dkim settings were last verified.
                  example: 2022-01-31
                  format: date
                  nullable: false
                  readOnly: true
                  type: string
                lastSpfVerifiedOn:
                  description: The date the Spf settings were last verified.
                  example: 2022-01-31
                  format: date
                  nullable: false
                  readOnly: true
                  type: string
              type: object
        description: EmailIdentity to Verify.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          dkimTokens:
                            items:
                              description: The Tokens which should be registred
                              example: u6deqmqhlgn3wxslcp4cugcz7ognh4gt
                              type: string
                            nullable: true
                            readOnly: true
                            type: array
                          emailIdentity:
                            description: The emailIdentity that can be used when sending email.
                            example: provider.com
                            nullable: false
                            readOnly: false
                            type: string
                          emailIdentityType:
                            description: The type of the set emailIdentity
                            enum:
                              - DOMAIN
                            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
                          isDkimVerified:
                            description: Indicates whether the EmailIdentity has passed Spf verfication.
                            example: true
                            nullable: false
                            readOnly: true
                            type: boolean
                          isSpfVerified:
                            description: Indicates whether the EmailIdentity has passed Spf verfication.
                            example: true
                            nullable: false
                            readOnly: true
                            type: boolean
                          lastDkimVerifiedOn:
                            description: The date the Dkim settings were last verified.
                            example: 2022-01-31
                            format: date
                            nullable: false
                            readOnly: true
                            type: string
                          lastSpfVerifiedOn:
                            description: The date the Spf settings were last verified.
                            example: 2022-01-31
                            format: date
                            nullable: false
                            readOnly: true
                            type: string
                        type: object
                    type: object
          description: Verified
        "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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Verify an EmailIdentity for a provider
      tags:
        - EmailIdentities
  "/providers/{providerId}/emailtemplates":
    get:
      description: |
        __Activity name :__ GetEmailTemplatesByProviderId

        Get a list of the email templates for an provider.

        __Note:__ Email templates can be defined on employer, provider and loket level. This endpoint returns for each emailtype the email template which is currently in use for the provider.
      operationId: GetEmailTemplatesByProviderId
      parameters:
        - description: The unique identifier of a provider
          in: path
          name: providerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            category:
                              description: The module to which the email template belongs
                              nullable: false
                              properties:
                                key:
                                  description: The id of the categorie to which the email template belongs.
                                  example: 3
                                  type: integer
                                value:
                                  description: The name of the categorie to which the email template belongs.
                                  example: Verlof
                                  type: string
                              readOnly: true
                              type: object
                            definedAtLevel:
                              description: The level at which the email template is defined.
                              enum:
                                - provider
                                - loket
                              example: provider
                              nullable: false
                              readOnly: true
                              type: string
                            dependsOnModule:
                              description: The module to which the email template belongs
                              nullable: false
                              properties:
                                description:
                                  description: The name of the module to which the email template belongs.
                                  example: Verlof
                                  type: string
                                id:
                                  description: The id of the module to which the email template belongs.
                                  example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                  format: uuid
                                  type: string
                              readOnly: true
                              type: object
                            email:
                              description: The configurable parts of the email template
                              nullable: false
                              properties:
                                body:
                                  description: The body text of the email.
                                  example: Je verlofaanvraag is behandeld.
                                  maxLength: 6000
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                senderEmail:
                                  description: The email address of the sender.
                                  example: noreply@loket.nl
                                  maxLength: 255
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                subject:
                                  description: The subjectline of the email.
                                  example: Verlofaanvraag behandeld
                                  maxLength: 255
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                              readOnly: false
                              type: object
                            isEmailTemplateEditable:
                              description: Indicates whether the email template can be editted.
                              example: true
                              nullable: false
                              readOnly: true
                              type: boolean
                            type:
                              description: The type of the email template
                              nullable: false
                              properties:
                                description:
                                  description: The description of the type of the email template.
                                  example: Verlofaanvraag behandeld (voor de indiener)
                                  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
                                sortOrder:
                                  description: A number used to sort the list.
                                  example: 210
                                  type: integer
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 email templates for an provider
      tags:
        - Emailtemplates
  "/providers/{providerId}/emailtemplates/{emailTemplateId}":
    get:
      description: |
        __Activity name :__ GetEmailTemplateByProviderIdAndEmailTemplateId

        Get the details of an email template. The available email template placeholders can be aquired by adding /metadata to the url.
      operationId: GetEmailTemplateByProviderIdAndEmailTemplateId
      parameters:
        - description: The unique identifier of a provider
          in: path
          name: providerId
          required: true
          schema:
            format: uuid
            type: string
        - description: The unique identifier of the record
          in: query
          name: emailtemplateId
          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 <TOKEN>
            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: emailTemplateId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            category:
                              description: The module to which the email template belongs
                              nullable: false
                              properties:
                                key:
                                  description: The id of the categorie to which the email template belongs.
                                  example: 3
                                  type: integer
                                value:
                                  description: The name of the categorie to which the email template belongs.
                                  example: Verlof
                                  type: string
                              readOnly: true
                              type: object
                            definedAtLevel:
                              description: The level at which the email template is defined.
                              enum:
                                - provider
                                - loket
                              example: provider
                              nullable: false
                              readOnly: true
                              type: string
                            dependsOnModule:
                              description: The module to which the email template belongs
                              nullable: false
                              properties:
                                description:
                                  description: The name of the module to which the email template belongs.
                                  example: Verlof
                                  type: string
                                id:
                                  description: The id of the module to which the email template belongs.
                                  example: b14acd0d-75d7-4fc8-8b22-4a3924585cab
                                  format: uuid
                                  type: string
                              readOnly: true
                              type: object
                            email:
                              description: The configurable parts of the email template
                              nullable: false
                              properties:
                                body:
                                  description: The body text of the email.
                                  example: Je verlofaanvraag is behandeld.
                                  maxLength: 6000
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                senderEmail:
                                  description: The email address of the sender.
                                  example: noreply@loket.nl
                                  maxLength: 255
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                                subject:
                                  description: The subjectline of the email.
                                  example: Verlofaanvraag behandeld
                                  maxLength: 255
                                  minLength: 1
                                  nullable: false
                                  readOnly: false
                                  type: string
                              readOnly: false
                              type: object
                            isEmailTemplateEditable:
                              description: Indicates whether the email template can be editted.
                              example: true
                              nullable: false
                              readOnly: true
                              type: boolean
                            type:
                              description: The type of the email template
                              nullable: false
                              properties:
                                description:
                                  description: The description of the type of the email template.
                                  example: Verlofaanvraag behandeld (voor de indiener)
                                  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
                                sortOrder:
                                  description: A number used to sort the list.
                                  example: 210
                                  type: integer
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 email template
      tags:
        - Emailtemplates
  "/providers/{providerId}/employers":
    post:
      description: |-
        __Activity name :__ PostEmployerByProviderId

        Create an employee for the provider (administratiekantoor) identified by the given providerId.
        Please take note of the following; a newly created Employer is not immediately accessible for the user. As this would require adding the Employer to a specific Loket team (which is a separate activity)

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.
      operationId: PostEmployerByProviderId
      parameters:
        - description: The unique identifier of a provider
          in: path
          name: providerId
          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 <TOKEN>
            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:
                - 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
        description: Employer to be created.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 employer
      tags:
        - Employer
  "/providers/{providerId}/externaltenants":
    get:
      description: |
        __Activity name:__ GetExternalTenantsByProviderId
            

        Get a list of external tenants that are available within the scope of this provider.
        An external tenant may be registered for a Loket user, and may be used to login to Loket using Azure Active Directory. 
      operationId: GetExternalTenantsByProviderId
      parameters:
        - description: The unique identifier of a provider
          in: path
          name: providerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: false
                          properties:
                            externalId:
                              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
                            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: The user-friendly name of the external tenant
                              example: Loket tenant
                              maxLength: 28
                              nullable: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 available external tenants (provider scope)
      tags:
        - External tenant
  "/providers/{providerId}/leavePolicies":
    get:
      description: |
        __Activity name :__ GetProviderLeavePoliciesByProviderId <br/>  <br/>  Returns all the leave policies for the given provider. These leave policies can be used to define a leave policy at employer level.
      operationId: GetProviderLeavePoliciesByProviderId
      parameters:
        - description: The unique identifier of a provider
          in: path
          name: providerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            accrualType:
                              description: "Indicates how leave is accrued (yearly, monthly or hourly)  "
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: |
                                    The key for the `accrualType`
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    The description for the `accrualType`
                                  example: Jaar
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              type: object
                            additionalLeave:
                              nullable: false
                              properties:
                                allocationType:
                                  description: Indicates how additional leave is to be assigned to the employments (linked to this leave policy).
                                  format: metadata
                                  nullable: false
                                  properties:
                                    key:
                                      description: |
                                        The key for the `additionalLeaveAllocationType`
                                      example: 1
                                      format: int32
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    value:
                                      description: |
                                        The description for the `additionalLeaveAllocationType`
                                      example: Boek alleen hoogste waarde
                                      nullable: false
                                      readOnly: true
                                      type: string
                                  readOnly: false
                                  type: object
                                referenceDate1:
                                  description: If `referenceDate2` has a value only the last 6 months of the year are allowed as values
                                  nullable: false
                                  properties:
                                    day:
                                      description: The day of the first reference date.
                                      example: 40
                                      format: int32
                                      maximum: 31
                                      minimum: 1
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    month:
                                      description: "The month of the first reference date "
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          description: |
                                            The key for the `referenceMonth`
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                        value:
                                          description: |
                                            The description for the `referenceMonth`
                                          example: Januari
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: false
                                      type: object
                                  type: object
                                referenceDate2:
                                  description: Only use if applicable
                                  nullable: true
                                  properties:
                                    day:
                                      description: The day of the second reference date.
                                      example: 40
                                      format: int32
                                      maximum: 31
                                      minimum: 1
                                      nullable: false
                                      readOnly: false
                                      type: integer
                                    month:
                                      description: "The month of the second reference date "
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          description: |
                                            The key for the `referenceMonth`
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: false
                                          type: integer
                                        value:
                                          description: |
                                            The description for the `referenceMonth`
                                          example: Januari
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: false
                                      type: object
                                  type: object
                              readOnly: false
                              type: object
                            dayOfTheMonthToPerformAutomaticLeaveCalculationOn:
                              description: |-
                                They day of the month on which the automatic accrual of (yearly or monthly) leave is performed. The yearly calculation is repeated every month to encompase any changes made that have affect on the past.
                                If for example 31 is chosen and a specific month does not have that day the logic will pick the first available date of said month.          
                              example: 12
                              format: int32
                              maximum: 31
                              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
                            leaveEntitlement:
                              nullable: true
                              properties:
                                excessLeaveToStatutory:
                                  description: The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.
                                  example: 40
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,3})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                statutory:
                                  description: The statutory leave (wetelijk verlof) linked employments are entitled to for a full time contract.
                                  example: 160
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,3})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                                wtr:
                                  description: The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.
                                  example: 40
                                  format: double
                                  maximum: 999.99
                                  minimum: 0.01
                                  nullable: true
                                  pattern: ^(\d{1,3})(.\d{1,2})?$
                                  readOnly: false
                                  type: number
                              readOnly: false
                              type: object
                            leaveRequest:
                              nullable: false
                              properties:
                                applyLeaveSchedule:
                                  description: Indicates whether the leave schedule can be enterd and is so it is used when calculating the sugested leave hours for a leave request
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                                leavePattern:
                                  description: |
                                    The applicable leave pattern for a period of 2 weeks can be stored in this object. Each field contains the number of leave(work) hours for that day in the 2-week period. <br /> Please note that the `leavePattern` should be left NULL if no data is present (as opposed to filling all fields with 0) <br /> Each field represent the number of hours the employee normally works on that day.
                                  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
                                useHolidaysInCalculation:
                                  description: |-
                                    Indicates whether the calculating for sugested leave hours for a leave request takes into account holidays. Is set to true no leave hours are calculated for "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."

                                    eg. When requesting leave for the 24th and 25th of december (25th being a national holiday) the calculation (8 hours a day) will return 8 when `useHolidaysInCalculation` is true and 16 when `useHolidaysInCalculation` is false
                                  example: false
                                  nullable: false
                                  readOnly: false
                                  type: boolean
                              readOnly: false
                              type: object
                            leaveUnitType:
                              description: Indicates what the unit type (hours or days) is. Employments linked to this leave policy use this leaveUnitType for their leave.
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: |
                                    The key for the unit type
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    The description for the leave unit type
                                  example: Uren
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              type: object
                            name:
                              description: The name of the leave policy
                              example: Normal leave
                              maxLength: 50
                              minLength: 1
                              nullable: false
                              readOnly: false
                              type: string
                            payoutLeaveImmediately:
                              description: If leave `accrualType` is set to based on hours worked (uren) then this field allows for the leave hours to be paid out directly instead of being accrued.
                              example: false
                              nullable: false
                              readOnly: false
                              type: boolean
                            roundTo:
                              description: Indicates to how many digits after the decimal point to round the numbers
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: |
                                    The key for the roundTo
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    The description for the roundTo
                                  example: "0.01"
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              type: object
                            roundingMethod:
                              description: "Indicates how to round the numbers "
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: |
                                    The key for the roundingMethod
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  description: |
                                    The description for the roundingMethod
                                  example: Logical
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 all the leave policies at provider level.
      tags:
        - Provider leave policy
  "/providers/{providerId}/logo":
    get:
      description: |-
        __Activity name :__ GetProviderLogo

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

        __Caching:__ This resource changes very infrequently and can be cached for a longer time.

        Get the logo of the provider of the user. In case no logo is know the service will return a 404.
      operationId: GetProviderLogo
      parameters:
        - description: The unique identifier of a provider
          in: path
          name: providerId
          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 <TOKEN>
            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 provider logo
      tags:
        - Provider
  "/providers/{providerId}/logo/{version}":
    get:
      description: |-
        __Activity name :__ GetProviderLogo

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

        __Caching:__ This resource changes very infrequently and can be cached for a longer time.

        Get the logo of the provider of the user. In case no logo is know the service will return a 404.
      operationId: GetProviderLogoByVersion
      parameters:
        - description: The unique identifier of a provider
          in: path
          name: providerId
          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 <TOKEN>
            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: An guid generated for caching. The value does not influence the output of this function. The provider/logo endpoint returns the URI of the current logo with the version.
          in: path
          name: version
          required: true
          schema:
            format: uuid
            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 provider logo
      tags:
        - Provider
  "/providers/{providerId}/notificationsets":
    get:
      description: |
        __Activity name :__ GetNotificationSetsByProviderId 


         List the available notification sets. 
      operationId: GetNotificationSetsByProviderId
      parameters:
        - description: The unique identifier of a provider
          in: path
          name: providerId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            description:
                              example: Salarisadministrateur
                              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
                            notifications:
                              items:
                                properties:
                                  createNumberOfDaysBeforeEvent:
                                    description: The number of days that the notification is created befor the event takes place.
                                    example: 30
                                    format: int32
                                    maximum: 99
                                    minimum: 0
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  isEnabled:
                                    description: Enable or disable a notification for a user
                                    nullable: false
                                    readOnly: false
                                    type: boolean
                                  notificationType:
                                    description: The notification set
                                    format: metadata
                                    nullable: true
                                    properties:
                                      key:
                                        example: 3
                                        format: int32
                                        nullable: false
                                        readOnly: false
                                        type: integer
                                      value:
                                        example: Start of employment
                                        maxLength: 70
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                  receiveDepartmentSignalsOnly:
                                    description: |-
                                      Only receive notification for your departments.
                                      Not relevant if the user is not a department manager.
                                    example: false
                                    nullable: false
                                    readOnly: false
                                    type: boolean
                                  sendMailWhenNotificationIsCreated:
                                    description: send an email when on creation of the notification
                                    example: false
                                    nullable: false
                                    readOnly: false
                                    type: boolean
                              type: array
                            numberOfLinkedEmployerUsers:
                              description: The number of employer users that are linked to this notification set
                              example: 435
                              format: int32
                              nullable: false
                              readOnly: true
                              type: integer
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 notification sets
      tags:
        - Notification sets
  "/providers/{providerId}/payrollprocessstatus":
    get:
      description: |
        __Activity name :__ GetPayrollProcessStatusByProviderId

        __Metadata :__  Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.

        __Defaults :__ The default value for payrollPeriod.payrollPeriodId can be acquired by adding `/defaults' to the POST URL. 

        Returns an array of objects. Each object contains information about the payroll administration and the payroll processes status.
      operationId: GetPayrollProcessStatusByProviderId
      parameters:
        - description: The unique identifier of a provider
          in: path
          name: providerId
          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 <TOKEN>
            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 payroll period to return
          example: 202201
          in: query
          name: payrollPeriodId
          required: true
          schema:
            format: int32
            type: integer
        - 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          properties:
                            administrationNumber:
                              description: The administration number is a free field commonly used to register the debtors number.
                              example: 134.26.94
                              maxLength: 15
                              nullable: true
                              type: string
                            cao:
                              description: The CAO (CLA -> collective labor agrement) of the "loonmodel" the payroll administration is linked to.
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 115
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: 18 Vishandel
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            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: 465
                              format: int32
                              nullable: false
                              type: integer
                            employerId:
                              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
                            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
                            groupClassification:
                              description: |-
                                The group classification for the payroll administration. This field is used for filtering and grouping within the interface.

                                `groupClassification` is a metadata field within the provider context. Possible values can be managed by the user.
                              format: metadata
                              nullable: true
                              properties:
                                key:
                                  example: 3
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: South
                                  nullable: false
                                  readOnly: true
                                  type: string
                              type: object
                            groupCode:
                              description: Number (integer) used for grouping administrations.
                              example: 40
                              format: metadata
                              nullable: true
                              readOnly: false
                              type: integer
                            hasAutomaticPayroll:
                              description: Indicates whether automatic payrolling is set
                              nullable: false
                              readOnly: true
                              type: boolean
                            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
                            loonmodel:
                              description: |-
                                The "loonmodel" (this is a loket.nl term) the payroll administration inherits the payrolling configuration from. Deviating from the loonmodel configuration on payrol administration level is posible.

                                `loonmodel` is a metadata field within the provider context. Possible values can be managed by the user.
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 929
                                  format: int32
                                  nullable: false
                                  type: integer
                                value:
                                  example: Vishandel monthly payrolling
                                  maxLength: 50
                                  nullable: false
                                  type: string
                              type: object
                            name:
                              description: Name of the administration
                              example: VST Consultancy
                              maxLength: 70
                              nullable: false
                              type: string
                            payrollPeriod:
                              format: metadata
                              nullable: false
                              properties:
                                announcements:
                                  nullable: false
                                  properties:
                                    hasUnreadAnnouncements:
                                      description: Indicates whether the administration has unread announcements
                                      example: false
                                      nullable: false
                                      readOnly: false
                                      type: boolean
                                  readOnly: true
                                  type: object
                                notifications:
                                  nullable: false
                                  properties:
                                    hasUnreadNotifications:
                                      description: Indicates whether the administration has unread notifications
                                      example: false
                                      nullable: false
                                      readOnly: false
                                      type: boolean
                                  readOnly: true
                                  type: object
                                payrollPeriodId:
                                  description: |
                                    The year and period of the payroll period
                                  example: 202004
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                payrollProcess:
                                  format: metadata
                                  nullable: false
                                  properties:
                                    methodOfCreation:
                                      format: metadata
                                      nullable: false
                                      properties:
                                        key:
                                          description: The key indicating how the payroll run was created.
                                          example: 2
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        value:
                                          description: The value describing how the payroll run was created.
                                          example: Individueel
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                    status:
                                      description: |
                                        Status of the payroll process in the period.
                                        Possible statuses are:
                                        - 0	Invalid
                                        - 1	Not started
                                        - 2	Queued
                                        - 3	Waiting for approval
                                        - 4	Incorrect and there is an approved preceding payrollrun
                                        - 5	Incorrect
                                        - 6	Approved 
                                        - 7	No results
                                        - 8	No results and there is an approved preceding payrollrun
                                      format: metadata
                                      properties:
                                        key:
                                          example: 6
                                          format: int32
                                          readOnly: true
                                          type: integer
                                        value:
                                          example: geannuleerde loonrun
                                          readOnly: true
                                          type: string
                                      readOnly: true
                                      type: object
                                  readOnly: true
                                  type: object
                                periodEndDate:
                                  description: |
                                    The last day of the period to which the payroll period data applies
                                  example: 2020-06-30
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                periodNumber:
                                  description: |
                                    The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53])
                                  example: 4
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                periodStartDate:
                                  description: |
                                    The first day of the period to which the payroll period data applies
                                  example: 2020-04-01
                                  format: date
                                  nullable: false
                                  readOnly: true
                                  type: string
                                year:
                                  description: |
                                    The year of the payroll period
                                  example: 2020
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              readOnly: true
                              type: object
                            payrollPeriodType:
                              description: Indicates the frequence of the payrolling process. Payrolling can be done on a montly (key 1), 4-weekly (key 3) or weekly basis (key 4).
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                                value:
                                  example: month
                                  maxLength: 50
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            shortName:
                              description: Shortened name of the administration
                              example: VST
                              maxLength: 12
                              nullable: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Payroll status for each administration.
      tags:
        - Payroll process status
  /qwoater/employers:
    get:
      description: |
        __Activity name :__ GetQwoaterEmployersByUser

        Returns a list of employerIds that have at least one Qwoater product enabled with the corresponding providerId and lastModifiedVersionNumber for the employer.

        **What does the 'last modified' version number reflect**

        The sequence number of an employer is a sequential number that reflects whether any changes have occurred in any of its UNDERLYING employments.

        More precisely, it reflects the sequence number after the latest change of any database record that relates to an employment within this employer.   What we consider to be 'underlying' employment data is based on a predefined set of tables, and of course given id.  This predefined set of tables can be found [here](../TablesLastModifiedVersionNumber.xlsx)

        The scope of this predefined set is to represent 'static' employment data (vaste gegevens), and thus excludes payroll period data (variabele gegevens).

        **When to use**

        This endpoint is most useful for integrations that regularly synchronize Loket employment data with another system.  As there are no webhooks available, in practice these integrations would need to regularly poll all data to see whether there any changes in the employment data.  The most elementary approach of getting all employment data every time you sync acquires a LOT of calls, in some cases even millions per day.  Even though we can handle quite a lot, this is not always the desired way for both client and server. Hence, this endpoint enables an alternative solution to set up such an integration.

        **How to use**

        With every update (including additions and deletions) the version number will increase. I.e. the version number will NEVER decrease over time.  (Please note this is not only true within the context of a single employer (or any other entity) but applies to all changes in the database).
        Consequently, in practice one would use this endpoint to check if any empLoyer version numbers have increased by applying the filter query parameter to the version field, for example `?filter=lastModifiedVersionNumber gt 70429274`.

        *Recommended usage*

        * Perform your regular synchronization of static employment data
        * Store the highest version number, for which you have now processed all changes. (You may use the following parameter to do this `?orderBy=-lastModifiedVersionNumber` )
        * Next time you want to perform synchronization. Call this endpoint with parameter `?filter=lastModifiedVersionNumber gt {{YourVersionNumber}}`
        * Only get employment information for employers that are included in that filtered list. (exclude all other employers as you already know there have been no changes since the last synchronization)
      operationId: GetQwoaterEmployersByUser
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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
                            lastModifiedVersionNumber:
                              description: The version number reflects the latest version of all predefined underlying tables of this employer.
                              example: 70429274999853
                              format: int64
                              nullable: false
                              readOnly: true
                              type: integer
                            providerId:
                              description: The unique identifier of a provider (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: 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: 2018-12-31
                            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 <field>
                              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.
                                See [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 using Qwoater
      tags:
        - Qwoater
  /rdwservices/additionaltaxliability:
    get:
      description: |
        __Activity name:__ GetAdditionalTaxliabilityByLicensePlateNumber

        This endpoint allows the user to acquire values for specific properties in the company car resource. This endpoint will require a license plate number (vehicle registration number), and will return aggregated data based on its RDW-registration.
      operationId: GetAdditionalTaxliabilityByLicensePlateNumber
      parameters:
        - description: A valid vehicle registration (license plate) number.
          example: 52LRX4
          in: query
          name: licensePlateNumber
          required: true
          schema:
            type: string
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: true
                        properties:
                          additionalTaxLiabilityGroup:
                            description: |
                              Indicates what additional tax liability percentage (bijtelling) should be used for calculating the tax liabiltiy in the payroll process.
                            format: metaData
                            nullable: true
                            properties:
                              key:
                                example: 1
                                format: int32
                                nullable: false
                                readOnly: false
                                type: integer
                              value:
                                example: Standaard tarief (25% tot 2017)
                                maxLength: 100
                                minLength: 0
                                nullable: false
                                readOnly: true
                                type: string
                            type: object
                          dateOfFirstAdmission:
                            description: "First day of admission for the vehicle (datum eerste toelating). "
                            example: 2018-01-01
                            format: date
                            nullable: false
                            readOnly: false
                            type: string
                          licensePlateNumber:
                            description: |
                              Vehicle registration (license plate of the vehicle). The number should be provided with or without any hyphens (-).
                            example: GP586D
                            maxLength: 15
                            minLength: 0
                            nullable: false
                            readOnly: false
                            type: string
                          valueForTaxPurposes:
                            description: |
                              The value of the vehicle for tax purposes. This field may only be NULL if a reason for no additional tax liability (reden voor geen bijtelling) is provided.
                            example: 20000
                            format: double
                            maximum: 999999.99
                            minimum: 0.01
                            nullable: false
                            pattern: ^(\d{1,6})(.\d{1,2})?$
                            readOnly: false
                            type: number
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 additional tax liability by the license plate number (company car)
      tags:
        - Fiscal company car
  /user:
    get:
      description: |
        __Activity name:__ GetUserByToken
            

        Properties of the current user.
      operationId: GetUserByToken
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          contactInformation:
                            nullable: true
                            properties:
                              emailAddress:
                                description: The e-mail address of the user.
                                example: info@loket.nl
                                maxLength: 255
                                nullable: false
                                pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                readOnly: true
                                type: string
                              phoneNumber:
                                description: The phone number of the user.
                                example: +31 13-1234567
                                maxLength: 15
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              placeOfEmployment:
                                description: The place of employment (standplaats) for the user.
                                example: Amsterdam office
                                maxLength: 24
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                            readOnly: false
                            type: object
                          personalDetails:
                            nullable: true
                            properties:
                              firstName:
                                description: The first name of the user
                                example: Susan
                                maxLength: 28
                                nullable: true
                                readOnly: false
                                type: string
                              initials:
                                description: The initials of the user
                                example: S.L.
                                maxLength: 6
                                nullable: false
                                readOnly: false
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Bergen
                                maxLength: 25
                                nullable: false
                                readOnly: false
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: van
                                maxLength: 10
                                nullable: true
                                readOnly: false
                                type: string
                            readOnly: false
                            type: object
                          photo:
                            description: A photo of the user to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                            example: https://api.loket.nl/v2/user/photo/{version}
                            format: url
                            nullable: true
                            readOnly: true
                            type: string
                          user:
                            nullable: true
                            properties:
                              userCustomSpecifiedRole:
                                description: |
                                  Further specification of the user role.
                                example: Secretariaat medewerker
                                maxLength: 50
                                nullable: true
                                readOnly: false
                                type: string
                              userSpecifiedRole:
                                description: The Role which the user has specified.
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 3
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Salarisadministrateur
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                            readOnly: false
                            type: object
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 current user
      tags:
        - User
    put:
      description: |
        __Activity name:__ PutUserByToken
            

        Edit some of the properties of the current user. Metadata can be acquired by adding /metadata to the path.
      operationId: PutUserByToken
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: false
              properties:
                contactInformation:
                  nullable: true
                  properties:
                    emailAddress:
                      description: The e-mail address of the user.
                      example: info@loket.nl
                      maxLength: 255
                      nullable: false
                      pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                      readOnly: true
                      type: string
                    phoneNumber:
                      description: The phone number of the user.
                      example: +31 13-1234567
                      maxLength: 15
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                    placeOfEmployment:
                      description: The place of employment (standplaats) for the user.
                      example: Amsterdam office
                      maxLength: 24
                      minLength: 1
                      nullable: true
                      readOnly: false
                      type: string
                  readOnly: false
                  type: object
                personalDetails:
                  nullable: true
                  properties:
                    firstName:
                      description: The first name of the user
                      example: Susan
                      maxLength: 28
                      nullable: true
                      readOnly: false
                      type: string
                    initials:
                      description: The initials of the user
                      example: S.L.
                      maxLength: 6
                      nullable: false
                      readOnly: false
                      type: string
                    lastName:
                      description: The last name of the user
                      example: Bergen
                      maxLength: 25
                      nullable: false
                      readOnly: false
                      type: string
                    prefix:
                      description: The prefix of the user
                      example: van
                      maxLength: 10
                      nullable: true
                      readOnly: false
                      type: string
                  readOnly: false
                  type: object
                photo:
                  description: A photo of the user to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                  example: https://api.loket.nl/v2/user/photo/{version}
                  format: url
                  nullable: true
                  readOnly: true
                  type: string
                user:
                  nullable: true
                  properties:
                    userCustomSpecifiedRole:
                      description: |
                        Further specification of the user role.
                      example: Secretariaat medewerker
                      maxLength: 50
                      nullable: true
                      readOnly: false
                      type: string
                    userSpecifiedRole:
                      description: The Role which the user has specified.
                      format: metadata
                      nullable: true
                      properties:
                        key:
                          example: 3
                          format: int32
                          nullable: false
                          readOnly: false
                          type: integer
                        value:
                          example: Salarisadministrateur
                          maxLength: 50
                          nullable: false
                          readOnly: true
                          type: string
                      type: object
                  readOnly: false
                  type: object
              type: object
        description: User 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          contactInformation:
                            nullable: true
                            properties:
                              emailAddress:
                                description: The e-mail address of the user.
                                example: info@loket.nl
                                maxLength: 255
                                nullable: false
                                pattern: ^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-||_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+([a-z]+|\d|-|\.{0,1}|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])?([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$
                                readOnly: true
                                type: string
                              phoneNumber:
                                description: The phone number of the user.
                                example: +31 13-1234567
                                maxLength: 15
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                              placeOfEmployment:
                                description: The place of employment (standplaats) for the user.
                                example: Amsterdam office
                                maxLength: 24
                                minLength: 1
                                nullable: true
                                readOnly: false
                                type: string
                            readOnly: false
                            type: object
                          personalDetails:
                            nullable: true
                            properties:
                              firstName:
                                description: The first name of the user
                                example: Susan
                                maxLength: 28
                                nullable: true
                                readOnly: false
                                type: string
                              initials:
                                description: The initials of the user
                                example: S.L.
                                maxLength: 6
                                nullable: false
                                readOnly: false
                                type: string
                              lastName:
                                description: The last name of the user
                                example: Bergen
                                maxLength: 25
                                nullable: false
                                readOnly: false
                                type: string
                              prefix:
                                description: The prefix of the user
                                example: van
                                maxLength: 10
                                nullable: true
                                readOnly: false
                                type: string
                            readOnly: false
                            type: object
                          photo:
                            description: A photo of the user to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
                            example: https://api.loket.nl/v2/user/photo/{version}
                            format: url
                            nullable: true
                            readOnly: true
                            type: string
                          user:
                            nullable: true
                            properties:
                              userCustomSpecifiedRole:
                                description: |
                                  Further specification of the user role.
                                example: Secretariaat medewerker
                                maxLength: 50
                                nullable: true
                                readOnly: false
                                type: string
                              userSpecifiedRole:
                                description: The Role which the user has specified.
                                format: metadata
                                nullable: true
                                properties:
                                  key:
                                    example: 3
                                    format: int32
                                    nullable: false
                                    readOnly: false
                                    type: integer
                                  value:
                                    example: Salarisadministrateur
                                    maxLength: 50
                                    nullable: false
                                    readOnly: true
                                    type: string
                                type: object
                            readOnly: false
                            type: object
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Edit current user
      tags:
        - User
  "/user/filtersettings/{employerId}":
    get:
      description: |
        __Activity name:__ GetUserFilterSettingsByEmployerId
            

        The User Filter settings for the current user for the employer. These settings are used by the backend to automaticaly filter the list of employments. 
      operationId: GetUserFilterSettingsByEmployerId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: employerId
          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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          employmentFilter:
                            nullable: false
                            properties:
                              filterOnAdministrations:
                                items:
                                  nullable: true
                                  properties:
                                    key:
                                      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
                                  type: object
                                nullable: false
                                type: array
                              filterOnDepartments:
                                items:
                                  nullable: true
                                  properties:
                                    key:
                                      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
                                  type: object
                                nullable: false
                                type: array
                              filterOnEmployedStatus:
                                description: Filter on the employedStatus, based on the start and end date of the employment.
                                enum:
                                  - AllEmployments
                                  - ActiveEmployments
                                  - ActiveAndFutureEmployments
                                  - ActiveAndHistoricEmployments
                                nullable: false
                                readOnly: false
                                type: string
                              filterOnOnCallEmployment:
                                description: Filter on the on-call status of an employment. A null value will result in the on-call employment filter not being active and therefore returning employments regardless of their on-call employment status.
                                nullable: true
                                type: boolean
                            type: object
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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 user filter settings
      tags:
        - User filter settings
    put:
      description: |
        __Activity name:__ PutUserFilterSettingsByEmployerId
            

        Edit the filter settings for the current user for the employer.

        Metadata can be acquired by adding /metadata to the path.
      operationId: PutUserFilterSettingsByEmployerId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: employerId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              nullable: false
              properties:
                employmentFilter:
                  nullable: false
                  properties:
                    filterOnAdministrations:
                      items:
                        nullable: true
                        properties:
                          key:
                            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
                        type: object
                      nullable: false
                      type: array
                    filterOnDepartments:
                      items:
                        nullable: true
                        properties:
                          key:
                            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
                        type: object
                      nullable: false
                      type: array
                    filterOnEmployedStatus:
                      description: Filter on the employedStatus, based on the start and end date of the employment.
                      enum:
                        - AllEmployments
                        - ActiveEmployments
                        - ActiveAndFutureEmployments
                        - ActiveAndHistoricEmployments
                      nullable: false
                      readOnly: false
                      type: string
                    filterOnOnCallEmployment:
                      description: Filter on the on-call status of an employment. A null value will result in the on-call employment filter not being active and therefore returning employments regardless of their on-call employment status.
                      nullable: true
                      type: boolean
                  type: object
              type: object
        description: Filters
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        nullable: false
                        properties:
                          employmentFilter:
                            nullable: false
                            properties:
                              filterOnAdministrations:
                                items:
                                  nullable: true
                                  properties:
                                    key:
                                      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
                                  type: object
                                nullable: false
                                type: array
                              filterOnDepartments:
                                items:
                                  nullable: true
                                  properties:
                                    key:
                                      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
                                  type: object
                                nullable: false
                                type: array
                              filterOnEmployedStatus:
                                description: Filter on the employedStatus, based on the start and end date of the employment.
                                enum:
                                  - AllEmployments
                                  - ActiveEmployments
                                  - ActiveAndFutureEmployments
                                  - ActiveAndHistoricEmployments
                                nullable: false
                                readOnly: false
                                type: string
                              filterOnOnCallEmployment:
                                description: Filter on the on-call status of an employment. A null value will result in the on-call employment filter not being active and therefore returning employments regardless of their on-call employment status.
                                nullable: true
                                type: boolean
                            type: object
                        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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Edit the user filter settings
      tags:
        - User filter settings
    servers:
      - description: Production server Global Filter
        url: https://k8s.loket.nl/globalfilter-microservice
  /user/photo:
    delete:
      description: |
        __Activity name :__ DeleteUserPhotoByToken

        Photo of the user to use as an avatar/profile picture
      operationId: DeleteUserPhotoByToken
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 user photo
      tags:
        - User
    get:
      description: |
        __Activity name :__ GetUserPhotoByToken

        Photo of the user to use as an avatar/profile picture

        __Caching:__ This resource changes very infrequently and can be cached for a longer time.
      operationId: GetUserPhotoByToken
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: Photo of an user
      tags:
        - User
    post:
      description: |
        __Activity name :__ PostUserPhotoByToken

        Photo of the user to use as an avatar/profile picture
      operationId: PostUserPhotoByToken
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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:
                data:
                  description: base64 encoded document file.
                  example: YQ==
                  nullable: false
                  readOnly: false
                  type: string
                mimeType:
                  description: The mimetype of the data.
                  example: image/jpeg
                  nullable: false
                  readOnly: false
                  type: string
        description: Logo to be uploaded for the user.
        required: true
      responses:
        "200":
          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: Post user photo
      tags:
        - User
  "/users/applicationsets/{applicationSetId}":
    delete:
      description: |
        __Activity name:__ DeleteUserApplicationSetByApplicationSetId

        Delete an applicationset for the user
      operationId: DeleteUserApplicationSetByApplicationSetId
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            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: 2018-12-31
                            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 <field>
                              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.
                                See [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: 2018-12-31
                            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 <field>
                              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.
                                See [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 for a user
      tags:
        - Applicationsets
    put:
      description: |
        __Activity name:__ PutUserApplicationSetByApplicationSetId


         Edit the details for an applicationset.
      operationId: PutUserApplicationSetByApplicationSetId
      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 <TOKEN>
            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: Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations).
          in: header
          name: If-Match
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json;version=2018-01-01:
            schema:
              nullable: true
              properties:
                applicationSetType:
                  description: |
                    The type of the set 
                  enum:
                    - Products
                    - ExportDataTemplate
                    - Rights
                  nullable: false
                  readOnly: true
                  type: string
                data:
                  description: |
                    Contains an array of objects in json structure.
                  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
                  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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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 
                            enum:
                              - Products
                              - ExportDataTemplate
                              - Rights
                            nullable: false
                            readOnly: false
                            type: string
                          data:
                            description: |
                              Contains an array of objects in json structure.
                            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
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 <field>
                          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.
                            See [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: 2018-12-31
                        format: date
                        type: string
                    type: object
                type: object
          description: Conflict
        "500":
          description: Internal Server Error
      summary: Edit the details of an applicationset for a user
      tags:
        - Applicationsets
  /users/initiatedworkflows:
    get:
      description: |
        __Activity name:__ GetInitiatedWorkflowsByBearerToken
            

        Get the workflows that are initiated by the user.
      operationId: GetInitiatedWorkflowsByBearerToken
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: true
                          properties:
                            allowedTransitions:
                              description: |-
                                In this object the posible transitions are returned.
                                By sending a request to the `href` with the given `httpVerb` and one of the options given in `transitions` in the body. The workflow is transitioned to the given state.
                              items:
                                properties:
                                  description:
                                    description: The description of the transition (task)
                                    example: Controleer de vergoedingen
                                    maxLength: 256
                                    nullable: true
                                    readOnly: true
                                    type: string
                                  href:
                                    example: https://api.loket.nl/v2/providers/employers/workflows/{workflowId}/transition
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  httpVerb:
                                    enum:
                                      - POST
                                      - PATCH
                                      - PUT
                                    format: enum
                                    nullable: false
                                    readOnly: true
                                    type: string
                                  transitions:
                                    example:
                                      - action: fabf3b25-abf9-4e8c-a8f7-81400d1b0e96
                                        description: Approve
                                      - action: abc31d45-f593-4d73-8078-6caba9cebdcc
                                        description: Reject
                                    items:
                                      properties:
                                        action:
                                          description: The unique identifier for the action to be taken
                                          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
                                        description:
                                          description: Description of the action
                                          example: Approve
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      type: object
                                    nullable: false
                                    readOnly: true
                                    type: array
                                type: object
                              nullable: true
                              readOnly: true
                              type: array
                            assignee:
                              description: A workflow is either assigned to a user or a role. A role can be filled by multiple users.
                              nullable: true
                              properties:
                                role:
                                  format: metadata
                                  nullable: true
                                  properties:
                                    description:
                                      description: A description of the role.
                                      example: Employer
                                      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
                                  type: object
                                user:
                                  format: metadata
                                  nullable: true
                                  properties:
                                    formattedName:
                                      description: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                      example: Jong, I
                                      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
                                    initials:
                                      description: The initials of the user
                                      example: I
                                      maxLength: 6
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    lastName:
                                      description: The last name of the user
                                      example: Jong
                                      maxLength: 25
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    prefix:
                                      description: The prefix of the user
                                      example: de
                                      maxLength: 10
                                      nullable: true
                                      readOnly: true
                                      type: string
                                  type: object
                              type: object
                            data:
                              description: A JSON representation of the mutation/data regarding this workflow
                              example:
                                address:
                                  city: Leiden
                                  country:
                                    key: 1
                                  houseNumber: 12
                                  houseNumberAddition: D
                                  postalCode: 1234 AA
                                  street: Voordijk
                              format: JSON
                              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
                            initiatedBy:
                              format: metadata
                              nullable: false
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            initiatedOn:
                              example: 2019-11-23T11:14:06Z
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            lastModifiedBy:
                              format: metadata
                              nullable: false
                              properties:
                                formattedName:
                                  description: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
                                  example: Jong, I
                                  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 user
                                  example: I
                                  maxLength: 6
                                  nullable: false
                                  readOnly: true
                                  type: string
                                lastName:
                                  description: The last name of the user
                                  example: Jong
                                  maxLength: 25
                                  nullable: false
                                  readOnly: true
                                  type: string
                                prefix:
                                  description: The prefix of the user
                                  example: de
                                  maxLength: 10
                                  nullable: true
                                  readOnly: true
                                  type: string
                              readOnly: true
                              type: object
                            lastModifiedOn:
                              description: date and time on which the last modification on the workflow was performed. This can be either by the system or a user.
                              example: 2019-11-23T11:14:06Z
                              format: date-time
                              nullable: false
                              readOnly: true
                              type: string
                            status:
                              description: Indicates the status of the workflow as a whole.
                              format: metadata
                              nullable: false
                              properties:
                                key:
                                  description: The unique identifier
                                  example: 1
                                  format: int32
                                  nullable: false
                                  readOnly: false
                                  type: integer
                                value:
                                  example: In progress
                                  nullable: false
                                  readOnly: true
                                  type: string
                              readOnly: false
                              type: object
                            trigger:
                              description: |-
                                Indicates the trigger that started the workflow.

                                `trigger` is a metadata field within the employer context. Possible values can be managed by the user. 
                              format: metadata
                              nullable: false
                              properties:
                                description:
                                  example: Address change for employee
                                  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
                              readOnly: true
                              type: object
                            workflowTemplate:
                              description: |-
                                Indicates what workflow template was used to initiate the workflow.

                                `workflowTemplate` is a metadata field within the employer context. Possible values can be managed by the user. 
                              format: metadata
                              nullable: false
                              properties:
                                description:
                                  example: Approval by employer
                                  maxLength: 256
                                  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
                                version:
                                  description: The version of the workflow template this workflow was based on. Changes to a workflow template do not affect existing workflows.
                                  example: 2
                                  format: int32
                                  nullable: false
                                  readOnly: true
                                  type: integer
                              readOnly: true
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Workflows initiated by the user
      tags:
        - Workflows
  /users/integrations:
    get:
      description: |
        __Activity name:__ GetIntegrationsByBearerToken
            

        List of all the integrations for the logon user
      operationId: GetIntegrationsByBearerToken
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        nullable: false
                        properties:
                          application:
                            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
                              isBlocked:
                                description: Indicates whether the application as a whole is blocked (for all users)
                                example: true
                                nullable: false
                                readOnly: true
                                type: boolean
                              logo:
                                description: An URI to the logo of the client
                                example: https://api.loket.nl/v2/application/{applicationId}/logo/{version}
                                nullable: true
                                readOnly: true
                                type: string
                              name:
                                example: ABC international
                                maxLength: 100
                                nullable: true
                                readOnly: true
                                type: string
                            readOnly: true
                            type: object
                          createdOn:
                            description: The time the integration was succesfully initiated
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: false
                            readOnly: true
                            type: string
                          isBlocked:
                            description: Indicates whether the application user combination is blocked (for this single user)
                            example: true
                            nullable: false
                            readOnly: false
                            type: boolean
                          lastLogin:
                            description: The time the integration was last active
                            example: 2018-05-08T15:16:49+02:00
                            format: date-time
                            nullable: true
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 all the integrations for the logon user
      tags:
        - User
  "/users/{userId}/applicationsets":
    get:
      description: |
        __Activity name:__ GetApplicationsetsByUserId
            

        Get the list of Applicationsets for a user. 
      operationId: GetApplicationsetsByUserId
      parameters:
        - description: The unique identifier of an user
          in: path
          name: userId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      _embedded:
                        items:
                          nullable: true
                          properties:
                            applicationSetType:
                              description: |
                                The type of the set 
                              enum:
                                - Products
                                - ExportDataTemplate
                                - Rights
                              nullable: false
                              readOnly: false
                              type: string
                            data:
                              description: |
                                Contains an array of objects in json structure.
                              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
                              example: Exportset Dienstverband
                              maximum: 50
                              nullable: false
                              readOnly: false
                              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 applicationsets for a user
      tags:
        - Applicationsets
    post:
      description: |
        __Activity name:__ PostApplicationSetByUserId
            

        Create an applicationset for a user.
      operationId: PostApplicationSetByUserId
      parameters:
        - description: The unique identifier of an user
          in: path
          name: userId
          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 <TOKEN>
            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 
                  enum:
                    - Products
                    - ExportDataTemplate
                    - Rights
                  nullable: false
                  readOnly: false
                  type: string
                data:
                  description: |
                    Contains an array of objects in json structure.
                  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
                  example: Exportset Dienstverband
                  maximum: 50
                  nullable: false
                  readOnly: false
                  type: string
              type: object
        description: Applicationset to add to the user.
        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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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 
                            enum:
                              - Products
                              - ExportDataTemplate
                              - Rights
                            nullable: false
                            readOnly: false
                            type: string
                          data:
                            description: |
                              Contains an array of objects in json structure.
                            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
                            example: Exportset Dienstverband
                            maximum: 50
                            nullable: false
                            readOnly: false
                            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: 2018-12-31
                            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 <field>
                              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.
                                See [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 applicationset for a user
      tags:
        - Applicationsets
  "/users/{userId}/yourcampusurl":
    get:
      description: |
        __Activity name :__ GetYourcampusUrlByUserId

        Get a URL to access the Yourcampus portal for a user
      operationId: GetYourcampusUrlByUserId
      parameters:
        - description: The unique identifier of an user
          in: path
          name: userId
          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 <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          url:
                            description: The URL to access the Benify portal
                            example: https://www.yourcampus.nl
                            format: url
                            nullable: false
                            readOnly: true
                            type: string
                          validUntilDate:
                            description: The time at which the validity of the url ends
                            example: 2022-05-08T15:16:49+02:00
                            format: date-time
                            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.
              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: 2018-12-31
                            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 <field>
                              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.
                                See [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 Yourcampus URL for a user
      tags:
        - Employee benefits
  "/wageprojection/cladata/{collectiveLaborAgreementId}":
    get:
      description: |
        __Activity name :__ GetClaDataForWageProjectionByCollectiveLaborAgreementId

        Get de configuration of a specific Collective labor agreement. This configuration (data) can then be used (as input) to perform a wage calculation or wage projection with.
      operationId: GetClaDataForWageProjectionByCollectiveLaborAgreementId
      parameters:
        - description: The unique identifier of the record
          in: path
          name: collectiveLaborAgreementId
          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 <TOKEN>
            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: 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: 2018-12-31
                            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: <some warning>
                              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.
                                See [the general documentation for more information](./#section/Response/Messages)
                              example: Warning
                              type: string
                        type: array
                    type: object
                  - properties:
                      content:
                        properties:
                          collectiveLaborAgreement:
                            properties:
                              baseForCalculation:
                                items:
                                  properties:
                                    baseType:
                                      format: metadata
                                      properties:
                                        key:
                                          description: |
                                            The number for the base type

                                              0 = nvt

                                              1	=	Vakantiebijslag
                                              
                                              2	=	Extra periode salaris
                                          example: 1
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                        value:
                                          description: |
                                            The description baseType
                                          example: Vakantiebijslag
                                          maxLength: 14
                                          nullable: false
                                          readOnly: true
                                          type: string
                                      type: object
                                    description:
                                      example: vakantie toeslag
                                      maxLength: 50
                                      nullable: false
                                      readOnly: true
                                      type: string
                                    key:
                                      description: The key for the baseForCalculation
                                      example: 1
                                      format: int32
                                      nullable: true
                                      readOnly: true
                                      type: integer
                                    percentage:
                                      description: The percentage
                                      example: 8
                                      maximum: 999.999999
                                      minimum: 0.000001
                                      readOnly: true
                                      type: number
                                    resultPayrollComponent:
                                      description: |
                                        A payroll component. These components are the core of the wage calculation software.
                                        `payrollComponents` is a metadata field within the payroll administration, loonmodel and cao context. Possible values can be managed by the user.
                                      format: metadata
                                      properties:
                                        description:
                                          description: |
                                            The description of the payroll component
                                          example: Output, VAKANTIE TOESL
                                          maxLength: 14
                                          nullable: false
                                          readOnly: true
                                          type: string
                                        key:
                                          description: |
                                            The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart.
                                          example: 82
                                          format: int32
                                          nullable: false
                                          readOnly: true
                                          type: integer
                                      type: object
                                  type: object
                                type: array
                              employments:
                                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
                                type: array
                              name:
                                description: Name of the company
                                example: Voorbeeld B.V.
                                maxLength: 70
                                nullable: false
                                readOnly: true
                                type: string
                              nextYear:
                                properties:
                                  available:
                                    description: Are next payroll years values available yes or no ?
                                    nullable: false
                                    readOnly: true
                                    type: boolean
                                  status:
                                    format: metadata
                                    nullable: true
                                    properties:
                                      key:
                                        description: The key for the status of the values
                                        example: 1
                                        format: int32
                                        nullable: false
                                        readOnly: true
                                        type: integer
                                      value:
                                        description: The status of the values
                                        example: Definitive
                                        maxLength: 50
                                        nullable: false
                                        readOnly: true
                                        type: string
                                    type: object
                                  year:
                                    description: The year for which the numbers are available
                                    example: 2017
                                    format: int32
                                    nullable: false
                                    readOnly: true
                                    type: integer
                                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: 2018-12-31
                            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 <field>
                              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.
                                See [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: Wage projection Collective labor agreements defaults
      tags:
        - Wage projection
  /wageprojection/collectivelaboragreements:
    get:
      description: |
        __Activity name :__ GetCollectiveLaborAgreementsByUserId

        Get a list of all collective labor agreements (CLA) accessible to the current user
      operationId: GetCollectiveLaborAgreementsByUserId
      parameters:
        - description: A valid Bearer token for authorizing the request.
          in: header
          name: Authorization
          required: true
          schema:
            example: Bearer <TOKEN>
            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: 2018-12-31
                            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: <some warning>
                              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.
                                See [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 company
                              example: Voorbeeld B.V.
                              maxLength: 70
                              nullable: false
                              readOnly: false
                              type: string
                          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: 2018-12-31
                            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 <field>
                              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.
                                See [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 collective labor agreements (CLA)
      tags:
        - Wage projection
x-tagGroups:
  - name: Base objects
    tags:
      - Provider
      - Employer
      - Administration
      - Employment
      - Employee
      - Concept employee
  - name: Absence and health
    tags:
      - Absence
      - Absence Progress
      - Contact history
      - Healthcare Insurance Act
      - Occupational disability
  - name: Application
    tags:
      - Application
      - Applicationsets
  - name: Assessment
    tags:
      - Assessment
  - name: Audit trail
    tags:
      - Audit trail
      - Audit trail payroll run
  - name: Authorizations
    tags:
      - Employer user authorizations
      - Authorization sets
      - Authorizations
  - name: Benefits
    tags:
      - Benefit in kind type
      - Benefits and deductions
      - Social security benefits
      - Pension benefit
      - Benefit in kind
      - Collective benefits and deductions
  - name: Billing
    tags:
      - Billable items
      - Billable item
  - name: Company car
    tags:
      - Fiscal company car
      - Company car
  - name: Custom fields
    tags:
      - Custom field
      - Employment custom field
      - Employee custom field
  - name: Dashboard
    tags:
      - Employer dashboard
      - Dashboard licenses
  - name: Declarations
    tags:
      - Declarations
      - Declarations attachments
  - name: Dossier (documents)
    tags:
      - Employer dossier
      - Employment dossier
      - Concept employee dossier
      - Document template
      - Generate document
      - Sign document
      - Document Management
  - name: Download request
    tags:
      - Download request
  - name: Email
    tags:
      - EmailIdentities
      - Email Identities
      - Emailtemplates
      - Email templates
      - Event notification configuration
  - name: Employer settings
    tags:
      - Contract code
      - Modules
      - Employment template
  - name: Employment others
    tags:
      - Fiscal properties
      - Other payroll variables
      - Social security
      - Create employment
      - Activate employee profile
      - Actuals
      - Base for employment fund calculation
      - Base for calculation
      - Deviating AWF Contribution
      - Transition compensation
      - Wachtgeld
  - name: Employee familiy and contacts
    tags:
      - Contact
      - Child
      - Partner
  - name: Education
    tags:
      - Education
      - Education further indication
      - Education type
  - name: External tenant
    tags:
      - External tenant
      - External tenant employer user
      - External tenant provider user
  - name: External product
    tags:
      - Achmea
      - Employee benefits
      - Qwoater
  - name: Financial administration
    tags:
      - Journal run
      - Journal run results
      - Journal run overview
      - Journal allocation
  - name: Function and Department
    tags:
      - Departments
      - Functions
      - Working hours
      - Organizational entity
  - name: Funds
    tags:
      - Abp funds
      - Employment funds
  - name: Imports
    tags:
      - Import
  - name: Leave
    tags:
      - Leave
      - Leave request
      - Leave balance
      - Leave policy
      - Provider leave policy
      - Leave policy and employment links
      - Leave types
      - Custom holiday
      - National holiday
      - Collective leave
      - Calendar
  - name: Lookup functions
    tags:
      - Address
      - Data New Business
      - Last modified version numbers
      - AOW date
      - Chamber of commerce
  - name: Notes
    tags:
      - Employer notes
      - Employment notes
      - Employee notes
      - Payroll run notes
  - name: Notifications, announcements, etc.
    tags:
      - Notification sets
      - Custom notification
      - Notification
      - Announcement
      - Mdv notifications
  - name: Payment information
    tags:
      - Payment information separate payments
      - Payment information non-SEPA
      - Attachment of earnings
      - Protected earnings
      - Payment information
  - name: Payroll
    tags:
      - Payroll run
      - Payroll run downloads
      - Payroll run results
      - Period ready for payroll
      - Payslip
      - Year-end statement
      - Payroll simulator
  - name: Payroll administration
    tags:
      - Payroll administration
      - Payroll administration reports
      - Payroll administration process overview
      - Payroll process status
      - Payroll component set
      - Year-end statement at administration level
      - Payroll period data on administration level
      - Payroll components
  - name: Payroll periods
    tags:
      - Payroll periods
      - Payroll results
      - Payroll period data
  - name: Payroll process actions
    tags:
      - Initialise Payroll Period
      - Initiate payroll run
      - Review payroll run
      - Undo payroll run
  - name: Payroll tax return
    tags:
      - Payroll tax return
      - Payroll tax return downloads
      - Payroll tax return response message
      - Payroll tax return by message reference
      - Initiate payroll tax return
      - Undo payroll tax return
  - name: Pension declaration
    tags:
      - Apg pension declaration
      - Upa pension declaration
  - name: Proforma
    tags:
      - Proforma
  - name: Self service and Preboarding
    tags:
      - Employee self service
      - Concept employee self service
      - Preboarding trajectory
  - name: User employer
    tags:
      - Employer user
      - Linked departments
      - Linked employers
      - Employer user notification settings
  - name: User
    tags:
      - User
      - User filter settings
  - name: Wage
    tags:
      - Paygrade
      - Wage
      - Wage proposal
      - Wage projection
      - Deviating hourly wage
      - Cost per hour
      - Collective wage
  - name: Workflow
    tags:
      - Workflows
      - Workflow trigger mapping
      - Change address request
      - Change contactinformation request
