{
"openapi": "3.1.0",
"info": {
"version": "V2",
"title": "Loket API",
"description": "**Is this your first time here? Please check out our [introduction to Loket (API)](./Introduction)**\n\n**The initial loading time of this developer portal may be very long due to the large number of endpoints designs being rendered when loading the page.\nWe are looking into an alternative solution but for now please bear in mind.**\n\n\n# General\nThe Loket API is a RESTful API that exposes the data and features of the Loket platform.\nThe API accepts and returns JSON and can only be accessed by registered users.\nThis documentation describes version 2 of the API.\n\n\nAre you looking to partner up and start building an integration based on the Loket RESTful API? Please check out the steps for partners on our [website](https://www.loket.nl/koppelingen/koppelen-met-loket/) .\n\nHave you received your client and user credentials from us? Check out the following Postman collection to help you start making your first API calls on our acceptance environment. We would recommend to install the Postman desktop app.\n\n[](https://god.gw.postman.com/run-collection/19604713-42728000-2df3-4ff0-908e-dc6ab410990c?action=collection%2Ffork&collection-url=entityId%3D19604713-42728000-2df3-4ff0-908e-dc6ab410990c%26entityType%3Dcollection%26workspaceId%3Ddde2c409-9fb2-4f40-9981-f937f73750ea#?env%5BLoket.nl%20Test%20Environment%5D=W3sia2V5IjoiQXV0aGVudGljYXRpb25TZXJ2ZXJVcmwiLCJ2YWx1ZSI6Imh0dHBzOi8vb2F1dGgubG9rZXQtYWNjLm5sLyIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJ0ZXh0Iiwic2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9vYXV0aC5sb2tldC1hY2MubmwvIiwic2Vzc2lvbkluZGV4IjowfSx7ImtleSI6Ikxva2V0QXBpVXJsIiwidmFsdWUiOiJodHRwczovL2FwaS5sb2tldC1hY2MubmwvIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InRleHQiLCJzZXNzaW9uVmFsdWUiOiJodHRwczovL2FwaS5sb2tldC1hY2MubmwvIiwic2Vzc2lvbkluZGV4IjoxfSx7ImtleSI6IkNsaWVudF9JZCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InRleHQiLCJzZXNzaW9uVmFsdWUiOiIiLCJzZXNzaW9uSW5kZXgiOjJ9LHsia2V5IjoiQ2xpZW50X1NlY3JldCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InRleHQiLCJzZXNzaW9uVmFsdWUiOiIiLCJzZXNzaW9uSW5kZXgiOjN9LHsia2V5IjoiUmVkaXJlY3RfVXJpIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoidGV4dCIsInNlc3Npb25WYWx1ZSI6IiIsInNlc3Npb25JbmRleCI6NH0seyJrZXkiOiJyZWZyZXNoX3Rva2VuIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoidGV4dCIsInNlc3Npb25WYWx1ZSI6IiIsInNlc3Npb25JbmRleCI6NX0seyJrZXkiOiJ0b2tlbiIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InRleHQiLCJzZXNzaW9uVmFsdWUiOiIiLCJzZXNzaW9uSW5kZXgiOjZ9XQ==)\n\n\nDo you want to contact us with any further questions or remarks regarding the Loket RESTful API? Please send an email to api@loket.nl, and we will get back to you.\n\n\n## Environments\nThe Loket API has two different environments.\nThe first environment is the \"acceptance\" environment which is used during development and returns test data.\nThe second environment is the production environment which is to be used exclusively by approved applications.\nBoth environments have their own URLs.\n* The acceptance environment can be accessed at https://api.loket-acc.nl/v2/ \n* The production environment can be accessed at https://api.loket.nl/v2/\n\n## OpenAPI documentation\nThe endpoints are defined using the [OpenAPI 3.1 specification](https://github.com/OAI/OpenAPI-Specification),\nan industry-wide recognized standard for describing REST API's.\n\n__Please note:__ the endpoint documentation in this portal is not designed to be fully compatible with any automatic code generation tools.\n\n## Change policy\nOver the course of time the API, and policies regarding the API can and will change. These changes are subject to the following guidelines.\n\n\nThe following states hold true for the change policy for this API.\n\n* Loket may sometimes introduce changes to the API and policies without advance notice. \n* Loket will try to inform users of any (breaking) change in advance.\n* Loket will not be liable to you or any third party for such modifications or any adverse effects resulting from such modifications.\n* Loket will try to avoid breaking changes as much as possible.\n\n## Notification periods\nIn regard to changes Loket will strive to adhere to the following notification periods per type of change.\nDue to our versioning strategy at resource level this API has the possibility to run multiple versions of the same resource at one time.\nThis allows for a window in which both the old and new version are available.\nAllowing for a gradual move to the new version. \n\n| Type of change | Notification period | Support period old version |\n|------------------|---------------|---------------|\n| Non breaking change | 2 weeks | no new version |\n| Breaking change | 2 weeks | 6 months |\n| Critical | Due to the nature of these changes we might not be able to follow the normal procedure for change managment | depends on the severity of the issue | \n\n\nWe define a __non breaking__ change as follows. Any change to the API that does not cause failures in the applications that consume that API.\n * Introducing a new optional field to an existing resource\n * Introducing a new endpoint\n * Introducing a new operation (GET/PUT/POST/PATCH/DELETE)\n * Introducing a new optional parameter to an endpoint\n * Introducing a new version for a resource\n\nWe define a __breaking change__ as follows. any change to an API that could potentially cause failures in the applications that consume that API.\n * Changing an existing JSON element (name, datatype, pattern, min/max length etc)\n * Removing a JSON element, endpoint, operation or parameter\n * Introducing a required JSON element\n * Introducing a required parameter to an endpoint\n * Passing the `obsoleteDate` of a version for a resource\n\n## Versioning\nThe Loket API uses two types of versioning. API versioning and resource versioning. \n\n\n__API versioning__\n\nAPI versioning is done via the path where after the domain URL (api.loket.nl) the path starts with the API version. The current version of the API is V2.\nThe API version is expected to change rarely as resource versioning is available to tackle most issues that need versioning.\n\n\n__Resource versioning__\n\nEvery __JSON__ resource in the API is versioned via the Accept header.\nAllowing users of the API to influence what version is returned by setting the __mandatory__ accept header.\nThe Accept header of request should have a value like `application/json;version=2018-01-01`. \nHere, the second part of the header is used to refer to a specific version of the resource (2018-01-01).\nWhen calling the API it is possible to supply other dates rather than the exact resources version(s). \nThe businesslogic will select the version that is ON or BEFORE the given date. If no accept header with a resource version is given the newest version of the resource is returned\n\n\n__For example:__ let's say there are two versions of a resource.\nThese are 2018-01-01 and 2018-09-01. When calling the API you supply `application/json;version=2018-08-01`,\nin that case the API will use the version 2018-01-01 as its the nearest version in the past.\n\n\nA response returns what `resourceVersion` was used and the 'obsoleteDate' of that version (in most cases this is NULL).\nThe `obsoleteDate` indicates when the resources version will no longer be available via the API.\nWith the introduction of a new version of a resource the `obsoleteDate` for the old version will be set to 6 months after the introduction of the new resource. \nAllowing consumers of the resource 6 months to incorporate the change. Failure to do so will likely lead to failure in the implementation.\n\nIn this developer portal you can find the service contracts for each, active, version of a resource.\nIf, only if, there are multiple versions of a resource you can select the corresponding schema at that resource.\n\n## Changelog\nThe changelog for this API can be found [here](/Changelog).\n\nWe strongly advise every user ofthe Loket REST API the subscribe to the email feed. Please check out the link on the changelog page.\n\n\n## Legal notices\nYour use and access to the API is expressly conditioned on your compliance with the policies and restrictions related to the API. \nIf Loket believes that you have or attempted to violate any term, condition, or the spirit of these policies or agreements, your right to access and use the API may be temporarily or permanently revoked. \n\n# Authentication\nAuthorization in the Loket API is based on the industry-standard OAuth 2.0 protocol. For general information on OAuth 2.0 we kindly refer to the publicly-available documentation, https://oauth.net/2/ \n\n\nAn authorized user is required to call the Loket API.\n\n__Note:__ This is an SSL-only API.\n\n__Note:__ Only TLS 1.2 is supported.\n\n| Environment | TokenUrl | \n| -------------------- | -------------------------------- | \n| Acceptance | https://oauth.loket-acc.nl/token |\n| Production | https://oauth.loket.nl/token | \n\nThe following OAuth 2.0 flows are supported\n\n* Authorization Code flow (standard)\n* Refresh Token flow (extension on the Authorization Code Flow)\n* SSO flow (single sign-on)\n* Password flow\n\n## Authorization code flow\nFor most clients only the authorization_code (and thus refresh_token) will be supported. \nPassword grant type is not available for an external client.\n\nPlease click the link below to see documentation on implementing the authorization code flow by external clients.\n\n__[Documentation on implementing the OAuth 2.0 authorization code flow](./OauthCode)__\n\n## Refresh token flow\nAfter the authorization code flow yields a refresh token the refresh_token grant can be used to obtain an access/bearer token.\nThe expire time of the access/bearer is also returned in the response please take this into account.\nWith the refresh token flow the two factor step will be skipped.\n\n_Refresh token request example:_\n```\nPOST /token \ngrant_type=refresh_token&refresh_token={RefreshToken123}&client_Id={Client123}&client_secret={Secret123}\n```\n\n_Refresh token response example:_\n```json\n{\n \"access_token\": \"JESJDhMBy0NPTM9SiXmYAzW45clOiQ5wSyDq3VWluguGNoKym4WPSiJoTDx67TQ\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3599,\n \"refresh_token\": \"nGJtF6j6SeQbHAg\",\n \"two_factor_state\": \"None\"\n}\n```\n## SSO flow\nThe SSO (single sign-on) flow is based on OAuth 2.0 and requires the authorization flow to be completed.\n\n__For more information see:__ [Documentation on OAuth 2.0 SSO flow (for allowed clients)](./OauthSSO)\n\n\n__Please note:__ Among other things, it is possible to set up an SSO flow with both Loket en Werknemerloket.\n\n\n## Password flow\nThe password flow is typically NOT enabled for external clients. Only by exception will the password flow be enabled for security (and practical) reasons.\n\n_Password token request examples:_\n\n```\nPOST /token \ngrant_type=password&username={UserName123}&password={Password123}&client_Id={Client123}&client_secret={Secret123}\n```\nWhether client_secret is required is dependent on the configuration of the client.\n\n# Authorization\nIn this section we explain how the API authorization service determines if a request is authorized or not.\n\n## The authorization entities\n\n| Entity | Description |\n| ----|----|\n| Client | Loket used the client as an additional authorization entity. By linking clients to activities clients can only perform those activities they are linked to. |\n| User | Is linked to a client (by performing the authorization code flow) and to a set of rechten (configuration in Loket)|\n| Module (product) | Enables certain functionality for the provider/employer. Modules can be enabled and disabled on both provider and employer level.|\n| Role | Influences if certain \"rechten\" are available to the users with said role. It can also influence the scope of the data returned. For example: the API will deny an \"afdelings manager\" access to employee's that are not in the \"afdeling\" (department) that user is manager of|\n| Activity | Every action in the API has its own activity. Using the Open API 3.0 standard these activity names are incorporated in the documentation using the `operationId` and in most cases are named in the description of an endpoint.|\n| Rights (rechten) | Represent a group of activities.|\n\n## The authorization process\nThis flow assumes that both user and client are correctly configured and have access to the API. \n\n1. Does the client have access to the activity?\n2. Does the user have access to the activity (through \"recht\")?\n3. Does the role have access to the activity (through \"recht\")?\n4. Does the provider/employer have the required module enabled for the activity?\n5. Does the user have access to the specified entity/ID?\n\nIf the answer to all the questions above is yes then the request is authorized otherwise the request is denied with a HTTP status code 403 (Forbidden).\nSee the simplified authorization flow in the figure below.\n\n__Side note:__ users are linked to rechten and clients are linked to activities. This leaves room for discrepancies.\nWhere a client cannot perform the activity because the client is not authorized to call that activity even though the user does have the \"recht\" granting access to the activity.\n\n\n\n## Which users can use the API\nIn almost all use-cases a Loket user should meet the following requirements to successfully setup an integration with that user.\n\n* The user must be a normal Loket user (so NOT a webservice user)\n* The user must be active (not blocked)\n* The user must have access to an employer \n * For provider users this is done by assigning the user to the appropriate Team(s)\n * For employer users this is done by creating a user for or linking the user to the appropriate employer(s)\n* The user must have all appropriate rights\n * For provider users this is done by assigning appropriate rights via Team (or alternatively, directly to the user)\n * For employer users this is done by assigning appropriate rights to the user on employer level\n\n\nHow to setup an integration is described in the [Authentication](../#section/Authentication) section.\n\n\n__Side notes:__ \n* A user can have access to multiple employers with different rights per employer.\n* Please note that users set up to use the SOAP webservices (webservicegebruikers) are in no way suited to perform calls to the RESTful API, these require entirely different user set-ups.\n* User management on production is typically done by the provider (i.e. the accountant) and sometimes the employer. This is NOT something Loket itself can do.\n\n# Data\n\n## Data types\nThe Loket API accepts and returns JSON.\nComform the [OpenAPI 3.0 specification](https://github.com/OAI/OpenAPI-Specification) the following data types are supported:\n* string\n* number (point is used to separate the integer part from the fractional part of a number)\n* integer (from OpenAPI)\n* object\n* array\n* boolean\n\nFor most of these types, further specifications can be found in the `format` and `pattern` specifications in the service contract. \nFor example a `format: date` added to a string field indicates a valid date must be supplied.\n\n## Metadata\nFields of the type 'metadata' are fields for which the possible values can be acquired via the metadata endpoint of the resource.\n\nThe metedata can be obtained by appending /metadata to the current endpoint.\nUsing the GET verb the endpoint will return a JSON output with \"all\" the metadata for the given resource.\nIn some cases multiple requests are needed to obtain all the metadata required, an exmple is given below.\nTypically different metadata endpoints are availalbe for the POST and the PUT endpoint.\n\n\nIf metadata endpoints are avaible for a given endpoint/resource is mentioned in the description of that endpoint.\n\n### Example response\n```json\n{[\n {\n \"field\": \"gender\"\n options: [\n {\n \"key\": 1,\n \"value\":\"Man\"\n }\n {\n \"key\": 2,\n \"value\":\"Vrouw\"\n }\n ]\n },\n {\n \"field\": \"country\"\n options: [\n {\n \"isoCode\":\"NL\",\n \"key\": 530,\n \"value\":\"Nederland\"\n }\n {\n \"isoCode\":\"BE\",\n \"key\": 540,\n \"value\":\"België\"\n }\n ]\n }\n\n]}\n\n```\n\n\n### Example urls\n\n__Acquiring metadata for a POST Wage__\n```\n/v2/v2/providers/employers/employees/employments/{employmentId}/wages/metadata\n```\n\n\n__Acquiring metadata for a PUT employee__\n```\n/v2/v2/providers/employers/employees/{employeeId}/metadata\n```\n\n__Multiple requests to get all the metadata__\n\nIn some cases there are metadata fields dependant on the selected value off another metadata field.\nSuch is the case when adding a new concept employee. This is done in the employer context while several of the metadata fields are dependant on the payrollAdministration context.\n\n\n__For example:__\n\n__Request 1__, first of a normal metadata request is performed. The response for this request will contain a list of payrolladministration for the given employer.\n```\n/v2/v2/providers/employers/b869ded6-0659-4d8d-9a8a-f9e22425ec9c/jobapplicant/metadata\n```\n\n__Request 2__, when a payrolladministration is selected perform a second request to acquire the payrolladministration specific metadata.\n```\n/v2/v2/providers/employers/jobapplicant/metadata/payrolladministration/54369214-14a1-41ab-892a-ea8438e34d6f\n```\n\n__Request 3__, if a `payScale` is selected perform a third request to acquire the `payGrade` for that `payScale`.\n```\n/v2/v2/providers/employers/jobapplicant/metadata/salaryScaleType/54369214-14a1-41ab-892a-ea8438e34d6f\n```\n\n### Types of metadata\nWe diferentiate between two types of metadata.\n\n1. Generic metadata field. The possible values for these fields are the same for every object no matter the provider, employer or employee etc. \nExamples are: country, gender and nationality.\n2. Context specific metadata field. Examples of contexts are employer, payroll administration, provider and Loket.\nIn most cases the possible values for these field are resources in themselves and can be managed via the API. \nIf a metadata field is context specific the context is given in the description of the field. \nExamples are: function, department and leaveType.\n\n\n__Note:__ some context specific metadata field can have multiple contexts. \n\nFor example: it is possible to define an export set in the provider context. \nMaking that export set available for all payroll administrations linked to the provider. \nIt is also possible to add an export set in the payroll administration context. That export set is only available to that payroll administration.\nWhen requesting the metadata of export set the user will be presented with a combined list of the provider and payroll administration export sets.\n\n## Default values\nMany fields in the API have a default value. \nIn order to assist our API users to adhere to these defaults when creating a record (POST) we provide `/defaults` endpoints.\n\n* An object returned by the `defaults`endpoint resembles a fully expanded GET-object of that resource. The only case when a part of the object is NOT fully expanded is for a metaData-object that does not have a default value (for example '\"gender\":NULL'). \n * Whether an object within the resource is of the type metaData is indicated in the service contracts of that resource.\n* Context is determined by the GUID given in the Path. Examples are employer, payroll administration, employee and employment.\n* A scope is sometimes required to determine the defaults values. A scope could be a date by which Loket can determine what default was active on that date. \n The scope can be set by supplying additional paraments in the request. If a scope is required but none is given the currently active or last know value is returned.\n* The fields with no default will be set to null (even if the field is normally non-nullable).\n* Because the GET-object is returned the readonly fields are also returned.\n\n\n\n__An example endpoint would be:__\n\n```\n/v2/v2/providers/employers/employees/employments/{employmentId}/payrollperioddata/defaults\n```\n\n__resulting in the following output:__\n\n```json\n{\n \"payrollPeriod\": null,\n \"shift\": {\n \"shiftNumber\": 1\n },\n \"payslipType\": {\n \"key\": 2\n },\n \"payslipText\": null,\n \"distributionUnit\": {\n \"key\": \"b14acd0d-75d7-4fc8-8b22-4a3924585cab\"\n },\n \"costCenter\": {\n \"key\": 2\n },\n \"costUnit\": {\n \"key\": 2\n },\n \"payrollComponents\": []\n}\n```\n\n__Note: Defaults endpoints are not yet generically available. If a Defaults endpoint exists this will be explicitly stated at that specific resource.__\n\n## Date chains\nFor most of the resources with a startDate and endDate a chain is maintained. Chain meaning that no records can overlap in time.\nLoket has two types of chains.\n\n\n1) __Broken chain:__ It is possible for gaps te exist between the records. It is also possible to add new records in between or before existing records aslong as no overlap occures.\n\n2) __Linked chain:__ No gaps between records are allowed. Its only possible to add new records to the end of the chain resulting in the closing of the reviouse record with the start date -1 as end date.\n\n__Note:__ Chains are sometimes maintained with an additional context. For example, For `benefits and deductions` the broken chain is maintained per `payrollComponent`. \nIt is possible to have multiple active records for different `payrollComponent` never two active records for the same `payrollComponent`. \n\n## Custom export\nFor some GET (list) endpoints the API supports exporting (part of) the output JSON as a XML/CSV file. This is done by setting the `X-ReportInput` and `Accept` header.\n\nThe `Accept` header supports the following 2 options:\n* CSV (text/csv;version=yyyy-MM-dd)\n* Excel (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;version=yyyy-MM-dd)\n\n\nThe `X-ReportInput` is a custom header that requires a JSON object with the following structure as input.\n\n1. fileNameWithoutExtension --> The filename without extension for the report 'FileNameWithoutExtension'\n2. delimiter --> The delimiter to be used. If not set \",\" is used\n3. decimalSeparator --> The decimalSepartor for number fields. If not set \".\" is used. \n4. fields --> Array of fields.\n\n\n The 'fields' object contains one or more fields with the following properties:\n1. fieldName --> A Xpath reference to the field to be included in the export\n2. reportColumnName --> The column name for the field\n3. format --> Allows only for date formatting. e.g. dd-MM-yyyy for csv or dd-mm-yyyy for Excel (Excel only usses lowercase)\n\n 3.1 For CSV: see https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings\n\n 3.2 For Excel: https://support.microsoft.com/en-us/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68\n\n__Example `X-ReportInput`:__\n```json\n{\n\"fileNameWithoutExtension\":\"MyExport\",\n\"delimiter\": \";\",\n\"decimalSepartor\": \",\",\n\"fields\":\n [\n {\n \"fieldName\": \"startDate\",\n \"reportColumnName\": \"In dienst datum\",\n \"format\": \"dd-MM-yyyy\"\n },\n {\n \"fieldName\": \"personalDetails.firstName\",\n \"reportColumnName\": \"First Name\"\n },\n {\n \"fieldName\": \"personalDetails.lastName\",\n \"reportColumnName\": \"Last Name\"\n }\n ]\n}\n```\n__Example request:__\n```CURL\ncurl \n--location \n--request GET 'https://api.loket.nl/v2/v2/providers/employers/155c8440-8ff6-4776-98db-5d2243a073e3/employees?orderby=employeeNumber' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: text/csv;version=2020-08-18' \\\n--header 'X-ReportInput: {\"FileNameWithoutExtension\":\"MyExport\",\"Fields\":[{\"fieldName\":\"personalDetails.initials\",\"reportColumnName\":\"Initials\"},{\"fieldName\":\"personalDetails.firstName\",\"reportColumnName\":\"First name\"},{\"fieldName\":\"personalDetails.lastName\",\"reportColumnName\":\"Last name\"}]}' \\--header 'Authorization: Bearer ZKoiC_g_NfYA3v0' \\\n```\n\n\n# Request\nA request to the Loket API consists of several components.\nEach of these components are discussed in this section.\n\n## Base URL\nThe API can be accessed at [https://api.loket.nl](https://api.loket.nl).\n The version of the API is specified in the URL. The current version of the Loket API is version 2. To access version 2 of the API, one simply appends `v2` to the base URL. The full base URL of the API is therefore [https://api.loket.nl/v2](https://api.loket.nl/v2).\n\n## Endpoints\nThe endpoints defined in the OpenAPI definition of the Loket API are appended to the base URL. For example, the endpoint `/v2/providers/employers/{employerId}/employees` can be accessed at [https://api.loket.nl/v2/v2/providers/employers/{employerId}/employees](https://api.loket.nl/v2/v2/providers/employers/{employerId}/employees).\n\n## Path parameters\n\nMost endpoints require path parameter(s) in order to specify the context of the request. For example, the endpoint `/v2/providers/employers/{employerId}/employees` contains the `employerId` path parameter. A path parameter is a unique identifier that identifies a specific resource, in this case an employer.\n\n## Pagination\n\nThe API supports two query parameters to control the pagination of the results: `pageNumber` and `pageSize`. Both of these query parameters only apply to endpoints that return lists of entities.\n\nThe `pageNumber` query parameter specifies which page of the collection to return. By default `pageNumber` is set to 1 which returns the first page of the collection. Note: the pageNumber refers to the page (with a given number of entities), NOT to a specific entity within a page!\n\nThe `pageSize` query parameter influences the number of entities per page. By default `pageSize` is set to 250. Note that this default may change in the future. It is not recommended to depend on this default when developing for the Loket API.\n\nExamples:\n\n* ```?pageNumber=2``` to return the second page\n* ```?pageSize=2``` to set the page size to two\n\n## Filtering\n\nThe API supports output filtering via the querystring parameter `filter`.\n\nFiltering is possible on all fields of the following datatypes:\n\n* string\n* integer\n* boolean\n* date-time\n* decimals\n\nThe following operators are available:\n\n| Operator | Description | Example |\n| -------------------- | --------------------- | ------------------------------- |\n| Comparison Operators | | |\n| eq | Equal | `city eq 'Redmond'` |\n| ne | Not equal | `city ne 'London'` |\n| lk | Like | `city lk 'Lond'` |\n| gt | Greater than | `price gt 20` |\n| ge | Greater than or equal | `price ge 10` |\n| lt | Less than | `price lt 20` |\n| le | Less than or equal | `price le 100` |\n| Logical Operators | | |\n| and | Logical and | `price le 200 and price gt 3.5` |\n| or | Logical or | `price le 3.5 or price gt 200` |\n\nBoth field names and values are case insensitive. It is possible to filter on nested fields by adding the parent object before the field with a '.' to separate them.\nDo remember to URL encode the filter parameters.\n\n### Examples\n\nAll employments with a cancellation periode in months (the value 4 corresponds to months time unit).\n\n```\n\n/v2/v2/providers/employers/{{employerId}}/employees/employments?filter=cancellationPeriodTimeUnit.key eq 4\n\n```\n\nAll employments with no endDate.s\n\n```\n\n/v2/v2/providers/employers/{{employerId}}/employees/employments?filter=enddate eq null\n\n```\n\n\nAll employments with an end date less or equal to 2017-01-01\n\n```\n\n/v2/v2/providers/employers/{{employerId}}/employees/employments?filter=enddate le '2017-01-01'\n\n```\n\nAll employees with a employee number greater or equal 1 and less or equal 5\n\n```\n\n/v2/v2/providers/employers/{{employerId}}/employees?filter=employeeNumber ge 1 and employeeNumber le 5\n\n```\n\n## Ordering\n\nAll Loket API resources support ordering of the elements in the response on a specific field. \nAll fields can be used in ordering. \nThe list can be ordered in ascending or descending order, with ascending being the default one. Ordering on multiple fields is also by using a ',' as a separator.\n\n### Examples\n\nOrder employers by company name ascending\n\n```\n\n/v2/v2/providers/employers?orderBy=companyName\n\n```\n\nOrder employers by company name descending\n\n```\n\n/v2/v2/providers/employers?orderBy=-companyName\n\n```\n\nOrder employers by company name descending then by house number ascending\n\n```\n\n/v2/v2/providers/employers?orderBy=-companyName,address.houseNumber\n\n```\n\n## Headers\n\nIn order to access the endpoints of the Loket API, at least two request headers need to be set. \n\n\n__1)__ the `Authorization` header is required in order to authorize the API call. \nThe value of this header is the word Bearer followed by a space and the access token acquired from the `/token` endpoint. \nFor example, if the acquired access token is `AbCdEf123456`, the value of the `Authorization` headers would be:\n\n```\nAuthorization: Bearer v69uloc3wcEFLePw2unot0FfAJfBocrvSwsrCo75JLUG7aE54zqSUnU\n```\n\n__2)__ The second header that is required for proper usage of the API, is the `Accept` header.\nThis header is used for the resource versioning feature and is therefore crucial for making sure the response remains the same when new resource versions are introduced.\nThe value of the `Accept` header differs per endpoint is defined in the OpenAPI documentation of the endpoints.\n\n```\nAccept: application/json;version=2018-01-01\n```\n## String trimming\nThe loket API doest not trim strings on input. \nWhen a string field is given with leading or trailing spaces these spaces are preserved.\nPlease take this into account when performing requests to the API. Perferably trim strings before sending them to the API. \n\n# Response\n\nIn addition to the responses defined in the OpenAPI documentation, the Loket API also provides additional fields that give more information about\nthe response and the entities requested. This section will explain the full response given by the Loket API by examining the example response below.\n\n\nExample 400 response\n\n\n```json\n\n{\n \"version\": {\n \"obsoleteDate\": null,\n \"resourceVersion\": \"2018-01-01\"\n },\n \"messages\": [\n {\n \"code\": 83,\n \"id\": null,\n \"type\": \"BrokenBusinessRule\",\n \"description\": \"[field] has an invalid length\",\n \"properties\": []\n }\n ]\n}\n\n```\n\n\nExample 200 response\n\n```json\n\n {\n \"totalSize\": 1,\n \"pageSize\": 250,\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"version\": {\n \"obsoleteDate\": null,\n \"resourceVersion\": \"2018-01-01\"\n },\n \"messages\": [],\n \"content\": {\n \"id\": \"2b4c119c-527c-4cbb-a5b2-f3a11e4b76cx\",\n ...\n }\n }\n\n```\n\n## Paging\n* `totalSize` has an integer value indicating the total number of entities irrespective of the page size.\n\n* `pageSize` has an integer value indicating the maximum number of entities returned per page. The page size can be influenced by setting the `pageSize` query parameter. See the section Query Parameters for more information.\n\n* `totalPages` has an integer value indicating the number of pages the requested collection holds given the specific pagesize.\n\n* `currentPage` has an integer value indicating the current page number. The current page number can be influenced by setting the `pageNumber` query parameter. See the section Query Parameters for more information.\n\n## Version\nThe `version` object provides information regarding the resource version of the entity requested.\n\n * `obsoleteDate` contains the date of discontinuation for the requested resource version. The value of this field can be `null` indicating that the requested resource version is not planned to be obsoleted at the time of the request.\n\n * `resourceVersion` shows the version of the requested entity. The resource version can be influenced by setting the `Accept` header.\n\n## Messages\nThe `messages` field contains a list of message objects related to the request made. Any warnings and errors will be communicated in this list of messages\n\n * `type` has a string value indicating the type of message. At this time the Loket API supports five types of messages: `BrokenBusinessRule`, `Warning`, `Exception` and `NotFound` .\n \n * `description` has a string value that describes the message that has occurred.\n\n * `code` is an identifying code for the message. Please note that this code may change in the future. See the documentation portal for possible message codes for an endpoint.\n\n * `id` relates the message to a specific entity in the reponse list. For example, in cases where a warning occurs for one of the entities in a list, the value of this field can be used to identify to which entity the warning applies. Currently implemented for endpoints where a multi-patch is performed (multiple actions are performed within one call) for example updating the status of one or more leaveRequests. \n \n * `properties` an array that can contain additional information regarding the message. Currently not yet fully implemented.\n\n* `_embedded` contains the list of entities as defined for each endpoint in the OpenAPI documentation. Please refer to that documentation for the contents of the `_embedded` field for each endpoint. For endpoints that return only one entity (detail endpoints) the `_embedded` field is replaced with a `content` field. The content of this field can also be found in the documentation for each endpoint.\n\n## Headers\n* `Expires` header is returned with every response to indicate how long a response can be cached\n* `Content-Disposition` header is used in case of downloads to provide a file name\n\n## HTTP status codes\n\nThe Loket API supports the following http status codes.\n\n| Code | Is returned when |\n|------------------|---------------|\n| 200 | The request to GET, PUT, PATCH or DELETE and object was recived and processed successfully. The response might still contain messages of the type warning. |\n| 201 | The request to insert (POST) a new object was recived and processed successfully. The response might still contain messages of the type warning.|\n| 400 | The request was received but could not be processed. The reason(s) will be given in the response. The content type of the response may be text/plain for API-level error messages, such as when trying to call the API without SSL otherwise the content will be application/json. |\n| 401 | The bearer token provided in the authorization header is invalid. Do not retry the request until a new (valid) bearer token is acquired. |\n| 403 | The user is not authorized to access the resource. The reason will be given in the response. Do not retry the request until the, configuration, issue is resolved. |\n| 404 | The resource requested was not found/does not exist. |\n| 50* | A unforseen error occurred. Please check the request if everything seems te be in order on your side contact the support team. Provide as much information as possible to resolve the issue. |\n\nNote: for a limited number of endpoint a so-called multi-patch may be performed (multiple actions within one call). In that case the status code will be 200 if at least on of the actions succeeds, if other any action(s) in that call fail(s) a message will be returned including the given id of that entity.\n\n## Caching\nThe API uses the `Expires` header to indicate how long the item can be reused from the local cache.\nIn most cases caching is not allowed for resources.\nExceptions exist, such as pictures like the employer logo and the employee photo, in these cases the cache duration is mentioned in the description of the resource.\n",
"x-logo": {
"url": "./logo-new.png"
}
},
"servers": [
{
"url": "https://api.loket.nl",
"description": "Production environment"
},
{
"url": "https://api.loket-acc.nl",
"description": "Acceptance environment"
}
],
"security": [],
"tags": [
{
"name": "Absence",
"description": "NL: Ziekmelding. Absences due to either sickness/illness or absence due to, for example, maternity or organ donation (in Dutch 'vangnet').\n\nPlease note: when adding or updating an Absence or AbsenceProgress there will be no additional 'Melding' created in Loket. This legacy mechanism in the older Loket GUI will NOT be included in the newer version of Loket\n"
},
{
"name": "Absence Progress",
"description": "NL: Ziekteverloop. Absences due to either sickness/illness or absence due to, for example, maternity or organ donation (in Dutch 'vangnet'). One Absence contains one or more AbsenceProgress, indicating the degree of occupational disability over time of the absence.\n\nPlease note: when adding or updating an Absence or AbsenceProgress there will be no additional 'Melding' created in Loket. This legacy mechanism in the older Loket GUI will NOT be included in the newer version of Loket\n"
},
{
"name": "Contact history",
"description": "NL: Contact historie. History of all contacts with the employee"
},
{
"name": "Leave",
"description": "NL: Verlof. Leave entries both addition and subtraction"
},
{
"name": "Leave request",
"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 balance",
"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 policy",
"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": "Provider 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": "Leave policy and employment links",
"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": "Collective leave",
"description": "These endpoints allow the user edit leave for multiple employments."
},
{
"name": "Leave policy accrual",
"description": "NL: Het opgebouwde verlof voor een verlofregeling"
},
{
"name": "Leave policy entitlement",
"description": "NL: Het verlofrecht voor een verlofregeling"
},
{
"name": "Leave import",
"description": "NL: Verlof importeren middels een csv bestand"
},
{
"name": "Administration",
"description": "NL: Administratie. Retrieve information about all administrations, both payroll administrations and non-payroll administrations."
},
{
"name": "Payroll administration",
"description": "NL: Salarisverwerkende administratie. Manage a payroll administration. A Payroll administration is the link to the payrolling configuration"
},
{
"name": "Non payroll administration",
"description": "NL: Niet salarisverwerkende administratie. Manage a non payroll administration. A non payroll administration doesn't have a payrolling configuration"
},
{
"name": "Payroll administration process overview",
"description": "NL: Overzicht met de status -en mogelijke acties voor een periode."
},
{
"name": "Payroll administration reports",
"description": "NL: Overzichten administratie. Download available reports on payroll administration level"
},
{
"name": "Automatic payroll configuration",
"description": "NL: Automatische processen. Manage the automatic payroll configuration for a given payroll administration"
},
{
"name": "Automatic payroll dates",
"description": "NL: Geplande datums automatische processen. Manage the automatic payroll dates for a given payroll administration"
},
{
"name": "Payroll component set",
"description": "NL: Exportset/componentset. Pre-defined sets of payroll components. Useful when working with large list of components"
},
{
"name": "Calendar",
"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": "Collective action",
"description": "NL: Endpoints waarmee inzicht in de status van collective acties kan worden verkregen."
},
{
"name": "Employee",
"description": "NL: Persoon. Manage an employee"
},
{
"name": "Contact",
"description": "NL: Contactpersoon. Contact person of an employee"
},
{
"name": "Occupational disability",
"description": "NL: WAO/WIA. In case of occupational disabilities these can be manged here"
},
{
"name": "Change address request",
"description": "Allows an employee the submit a change of address"
},
{
"name": "Change contactinformation request",
"description": "Allows an employee the submit a change of contactinformation"
},
{
"name": "Employer",
"description": "NL: Werkgever. Manage an employer"
},
{
"name": "Authorizations",
"description": "NL: Autorisaties (toegestane activities). Acquire the autorizations the user has for the given provider or employer"
},
{
"name": "Concept employee",
"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. This is due to the fact that most systems don't have all the fields required to create a new employment in Loket. 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 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.\n"
},
{
"name": "Concept employee contact person",
"description": "NL: Concept Werknemer Contactpersoon. Manage contact persons for concept employees. Contact persons are people associated with the concept employee who can be contacted in case of emergencies or for administrative purposes.\n"
},
{
"name": "Notification",
"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": "Announcement",
"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": "Employer dashboard",
"description": "NL: Werkgever HR dashboard. Go to the Qlik employer dashboard"
},
{
"name": "Data New Business",
"description": "Acquire a token to call the Data New Business (DNB) API"
},
{
"name": "Functions",
"description": "NL: Functies. Manage the functions for the employer"
},
{
"name": "Departments",
"description": "NL: Afdelingen. Manage the departments for the employer"
},
{
"name": "Workflow trigger",
"description": "Manage the workflow triggers for the employer. Workflow triggers are triggers that trigger a workflow."
},
{
"name": "Workflow trigger mapping",
"description": "Manages the connection between workflow triggers and their associated workflow template. With this resource you can manage which trigger will trigger what workflow."
},
{
"name": "Workflow template",
"description": "Manage the workflow templates for the employer. Workflow template define what happens when a workflow is triggered."
},
{
"name": "Custom holiday",
"description": "NL: Eigen feestdagen. Manage the custom holidays for the employer."
},
{
"name": "National holiday",
"description": "NL: Nationale feestdagen. Manage the national holidays for the employer."
},
{
"name": "Billable item",
"description": "NL: Factureerbare items. Manage billable items for the employer"
},
{
"name": "Preboarding trajectory",
"description": "NL: Preboarding trajecten. "
},
{
"name": "Employee self service wage projection",
"description": "NL: MijnLoket salaris berekenen. Wage projection endpoints available to employees via the Employee Self Service portal."
},
{
"name": "Distribution unit",
"description": "NL: Verdelingseenheid. Manage the distribution units for the employer"
},
{
"name": "Employment",
"description": "NL: Dienstverband. Manage an employment"
},
{
"name": "Organizational entity",
"description": "NL: Organisatorische Eenheid/ WerknemerFunctie. Manage the organizational entity for an employment, this includes but is not limited to department and function.
For Organizational Entity records, so called 'linked chain' business logic applies. This means that the records for that payroll component may NOT overlap each other, based on startDate and endDate of each record, AND because it is a linked chain is not allowed to have 'gaps' between separate records. This also means that if an existing record in the chain is not closed and a subsequent record is created than Loket will automatically set the endDate for the already existing record (and vice versa when deleting a record).\n"
},
{
"name": "Payroll period data",
"description": "NL: Variabele gegevens. Payroll period data (e.g. hours worked or specific bonus) relates to a single payroll period.\n\nThere are also several other payroll related resources that work with start and end dates allowing these resources to span multiple payroll periods. We refer to those resources as payroll data, however THIS endpoint allows the user to determine only the value of specific payroll components for a specific payroll period (variabele gegevens, vs vaste gegevens). The payroll components that may be used as payroll period data (f.e. example component 1 relates to the normal hours worked in that period) are specific for the payroll administration to be used, even though there are some overall generic consistencies."
},
{
"name": "Benefits and deductions",
"description": "NL: Toeslagen. Payroll component data for part of, one or multiple payroll period(s). If the same `payrollComponent.Key` is also present in the `payroll period data` for a payroll period then, depending on the configuration in `payroll period data` the two values will either be 1) added up; or 2) payroll period data will overwrite the BenefitsAndDeduction for the given payroll period. Only certain payroll components are usable as a Benefit and Deduction, the corresponding categories are listed in payrollComponent.category in this resource.
Per payroll component a so called 'broken chain' business logic applies. This means that the records for that payroll component may NOT overlap each other, based on startDate and endDate of each record. Also, if an existing record in the chain is not closed and a subsequent record is created than Loket will automatically set the endDate for the already existing record.\n"
},
{
"name": "Benefits and deductions import",
"description": "NL: Toeslagen. Het exporteren -en importeren van toeslagen.\n"
},
{
"name": "Wage",
"description": "NL: Beloning. Manage the wage of an employment
For Wage records, so called 'linked chain' business logic applies. This means that the records for that payroll component may NOT overlap each other, based on startDate and endDate of each record, AND because it is a linked chain is not allowed to have 'gaps' between separate records. This also means that if an existing record in the chain is not closed and a subsequent record is created than Loket will automatically set the endDate for the already existing record (and vice versa when deleting a record).\n"
},
{
"name": "Wage import",
"description": "NL: Beloningsrecords importeren middels een csv bestand"
},
{
"name": "Working hours",
"description": "NL: Werktijd/ Arbeidstijd. Manage the working hours of an employment
For WorkingHours records, so called 'linked chain' business logic applies. This means that the records for that payroll component may NOT overlap each other, based on startDate and endDate of each record, AND because it is a linked chain is not allowed to have 'gaps' between separate records. This also means that if an existing record in the chain is not closed and a subsequent record is created than Loket will automatically set the endDate for the already existing record (and vice versa when deleting a record).\n"
},
{
"name": "Payslip",
"description": "NL: Loonstroken/loonresultaten werknemer. Download the payslip(s) for an employment"
},
{
"name": "Year-end statement",
"description": "NL: Jaaropgave. Download the year-end statement(s) for an employment"
},
{
"name": "Year-end statement at administration level",
"description": "NL: Jaaropgave. Download the year-end statement(s) for the employments of a payroll administration"
},
{
"name": "Payment information",
"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 separate payments",
"description": "NL: Excasso afgesplitst van netto. This entity indicates, if applicable, the bank account(s) (i.e. IBAN's) where a given amount of the net salary for this employment will be paid to.\n\nNormally, the IBAN for the payment of net wage will be set by the PaymentInformation(SEPA) record. However, this entity allows to take a part of the net salary (a fixed amount) and set this to a different IBAN (for that part of the payment). For example, when a person wants to have part of his earnings to his regular banking account and part of his earnings to his savings account.\n"
},
{
"name": "Payment information non-SEPA",
"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": "Fiscal properties",
"description": "NL: Fiscaal / Fiscale gegevens. Manage the fiscal property settings for an employment."
},
{
"name": "Fiscal company car",
"description": "NL: Werknemer auto fiscaal. Registration of company car for fiscal (tax-related) purposes"
},
{
"name": "Company car",
"description": "NL: Werknemer auto. Registration of company car for HRM purposes"
},
{
"name": "Other payroll variables",
"description": "NL: Diversen salarisverwerking. A collection of a divers set of payroll, wagetax and pension variables."
},
{
"name": "RDW services",
"description": "Rijksdienst voor het Wegverkeer (RDW)"
},
{
"name": "Chamber of commerce",
"description": "NL: Het opvragen van basis bedrijfsinformatie bij de kamer van koophandel."
},
{
"name": "Employment funds",
"description": "NL: Fonds. The funds the employment partakes in"
},
{
"name": "Abp funds",
"description": "NL: Abp Fonds. The abp funds the employment partakes in"
},
{
"name": "Base for employment fund calculation",
"description": "NL: FondsGrondslag. The base used in the calculation of the employment fund contribution"
},
{
"name": "Base for calculation",
"description": "NL: Grondslag. The base used in certain calculation. Like the base amount to calculate leave allowance over"
},
{
"name": "Social security",
"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 benefits",
"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": "Healthcare Insurance Act",
"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": "Attachment of earnings",
"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": "Protected 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": "Deviating AWF Contribution",
"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": "Transition compensation",
"description": "NL: Transitievergoeding. Calculation help for determining tranistion compensation amount (transitievergoeding)"
},
{
"name": "Activate employee profile",
"description": "NL: Activeer profiel."
},
{
"name": "Pension benefit",
"description": "NL: Pensioen uitkering. Pension benefit"
},
{
"name": "Actuals",
"description": "NL: Huidige gegevens"
},
{
"name": "Achmea",
"description": "NL: Achmea Verzuimverzekering. Manage the insurance contracts with Achmea"
},
{
"name": "Benify",
"description": "Get access to the Benify portal"
},
{
"name": "Qwoater",
"description": "Functionality to enable the Qwoater -> Loket integration"
},
{
"name": "Payroll periodes",
"description": "NL: Verloninsperiode. Payroll periods"
},
{
"name": "Audit trail",
"description": "NL: Mutatieverslag. Allows the user to see the changes that were made over time"
},
{
"name": "Payroll results",
"description": "NL: Loonresultaten. Payroll results"
},
{
"name": "Payroll run",
"description": "NL: Verloningsrun/loonrun. Manage the payroll runs"
},
{
"name": "Payroll run downloads",
"description": "NL: Verloningsrun downloads. Download payroll runs related output (payslip, wage sheets etc)"
},
{
"name": "Payroll run results",
"description": "NL: Loonresultaten per run. Acquire the data of the results of a payroll run"
},
{
"name": "Period ready for payroll",
"description": "NL: Klaar met muteren."
},
{
"name": "Provider",
"description": "NL: Provider (i.e. accountant) Provider related endpoints."
},
{
"name": "Authorization sets",
"description": "NL: Autorisatie sets."
},
{
"name": "Modules",
"description": "NL: Producten."
},
{
"name": "Provider dashboard",
"description": "NL: Go to the provider dashboard"
},
{
"name": "Provider reports misc",
"description": "NL: Miscellaneous provider reports. Miscellaneous provider reports."
},
{
"name": "Journal run",
"description": "NL: Journaalrun. Manage the journal runs"
},
{
"name": "Journal run results",
"description": "NL: Journaalrun resultaten. Acquire the data of the results of a journal run"
},
{
"name": "Journal run cumulative results",
"description": "NL: Journaalrun cumulatieve resultaten. Acquire the data of the results of a journal run"
},
{
"name": "Journal allocation",
"description": "NL: Verdeling journaal. Manage of the allocation to different costCenters and costUnits for a given employment"
},
{
"name": "Journal run overview",
"description": "NL: Journaal run overzicht. Journal run overview in csv format"
},
{
"name": "Payroll period data on administration level",
"description": "NL: Browser variabele gegevens. Payroll period data on administration level. (Get periods via payroll periods within the payroll category)"
},
{
"name": "Payroll tax return",
"description": "NL: Loonaangifte. Manage the payroll tax returns"
},
{
"name": "Payroll tax return downloads",
"description": "NL: Loonaangifte downloads. Download tax return related output"
},
{
"name": "Payroll tax return response message",
"description": "NL: Loonaangifte response message. Payroll tax return response message"
},
{
"name": "Payroll tax return by message reference",
"description": "NL: Loonaangifte obv berichtkenmerk. For some external parties it is more practical to perform these actions based on the messageReference as identifier."
},
{
"name": "Undo payroll tax return",
"description": "NL: Loonaangifte verwijderen. In exceptional cases the payroll tax return could be undone after it already has been approved"
},
{
"name": "Address",
"description": "Acquire address data"
},
{
"name": "Child",
"description": "Manage children for an employee"
},
{
"name": "Partner",
"description": "Manage partners for an employee"
},
{
"name": "Employment template",
"description": "NL: Dienstverbandsjabloon. Templates (sjablonen) for creating a new employment"
},
{
"name": "Workflows",
"description": "All workflow related endpoints"
},
{
"name": "Workflow progress",
"description": "Workflow progress"
},
{
"name": "Declarations",
"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 attachments",
"description": "NL: Declaraties/werknemermutaties bijlagen. Declarations (werknemermutaties) may have an attachment linked to it. (via Qwoater dossier)"
},
{
"name": "Initialise Payroll Period",
"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": "Initiate payroll run",
"description": "NL: Start verloningsrun. This endpoint may be used to start running the actual process of a payroll run. (Verlonen)"
},
{
"name": "Review payroll run",
"description": "NL: Verloningsrun goedkeuren/annuleren. After the payroll run has been successfully processed (status 1) the results of the run may be either confirmed or cancelled."
},
{
"name": "Undo payroll run",
"description": "NL: Verloningsrun verwijderen. In exceptional cases the payroll run could be undone after it already has been approved."
},
{
"name": "Paygrade",
"description": "Salarisschaalcel"
},
{
"name": "Employment dossier",
"description": "Employment dossier (werknemerdossier). Via Qwoater"
},
{
"name": "Employer dossier",
"description": "Employer dossier (werkgeverdossier). Via Qwoater"
},
{
"name": "Concept employee dossier",
"description": "Concept employee dossier (concept werknemerdossier). Via Qwoater"
},
{
"name": "Document Management",
"description": "Administrative features related to document management."
},
{
"name": "Assessment",
"description": "Initiate an assessment. (External)."
},
{
"name": "Apg pension declaration",
"description": "NL: Pensioenaangifte APG. Pension declation (pensioenaangiften) for APG ."
},
{
"name": "Upa pension declaration",
"description": "NL: Pensioenaangifte UPA. Pension declation (pensioenaangiften) for UPA ."
},
{
"name": "Pension declaration",
"description": "NL: Pensioenaangifte. Pension declation (pensioenaangiften) collective."
},
{
"name": "Paww declaration",
"description": "NL: Aangifte PAWW. Paww declation (aangifte PAWW) for PAWW ."
},
{
"name": "Download request",
"description": "NL: Werkgever Download Verzoek. An employer user may create a so-called download request. Once this request has been successfully 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": "Cost per hour",
"description": "NL: KPU/ Kostprijs per uur. Indicates cost per hour for this employment"
},
{
"name": "Create employment",
"description": "NL: Extra dienstverband. Create an additonal employment for an already existing Employee (tweede dienstverband)"
},
{
"name": "Deviating hourly wage",
"description": "NL: Afwijkend uurloon. Deviating hourly wage"
},
{
"name": "Wachtgeld",
"description": "NL: Wachtgeld. Redundancy pay"
},
{
"name": "Benefit in kind",
"description": "NL: Verstrekking. Benefit in kind"
},
{
"name": "Custom notification",
"description": "NL: Eigen signaal. Custom notification"
},
{
"name": "Education",
"description": "NL: Opleiding. Education"
},
{
"name": "Last modified version numbers",
"description": "The version number of an employer or employment may be used to decrease the number of calls in your sync-based integration."
},
{
"name": "Employment custom field",
"description": "NL: Dienstverband eigen veld. Employment custom field"
},
{
"name": "Employee custom field",
"description": "NL: Persoon eigen veld. Employee custom field"
},
{
"name": "Custom field",
"description": "NL: Eigen veld. Custom field"
},
{
"name": "Education type",
"description": "NL: Soort opleiding. Education type"
},
{
"name": "Education further indication",
"description": "NL: Opleiding nadere aanduiding. Education further indication"
},
{
"name": "Contract code",
"description": "NL: Contractcode. Contract code"
},
{
"name": "Benefit in kind type",
"description": "NL: Soort verstrekking. Benefit in kind type"
},
{
"name": "Document template",
"description": "NL: Document templates tbv documentgeneratie"
},
{
"name": "Generate document",
"description": "NL: Genereer een document op basis van een template"
},
{
"name": "Sign document",
"description": "NL: Onderteken een document"
},
{
"name": "User",
"description": "NL: De Loketgebruiker. Loket user"
},
{
"name": "External tenant",
"description": "External tenants may be used to login to Loket via Azure Active Directory"
},
{
"name": "External tenant employer user",
"description": "External tenants may be used to login to Loket 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 provider user",
"description": "External tenants may be used to login to Loket 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": "User filter settings",
"description": "The filtersettings for the user to filter the employments."
},
{
"name": "Email templates",
"description": "NL: Emailteksten."
},
{
"name": "Applicationsets",
"description": "NL: Voorgedefineerde sets met bijvoorbeeld producten, rechten en exportvelden."
},
{
"name": "EmailIdentities",
"description": "NL: EmailIdenties die kunnen worden gebruikt als afzender bij het versturen van email."
},
{
"name": "Email Identities",
"description": "NL: Email Identies die kunnen worden gebruikt als afzender bij het versturen van email."
},
{
"name": "Wage proposal",
"description": "Salarisvoorstel"
},
{
"name": "Signal paygrade adjustment",
"description": "NL: Salarisschaal aanpassingen signaleren."
},
{
"name": "Collective signal paygrade adjustment",
"description": "NL: Salarisschaal aanpassingen signaleren (Collectief)."
},
{
"name": "Year transition",
"description": "NL: Jaarovergang. Request a year transition for a payroll administration and year. This will close the given year and open a new year."
},
{
"name": "Reports new style",
"description": "NL: Rapportages nieuwe stijl. Reports new style"
}
],
"paths": {
"/v2/providers/employers/employees/{employeeId}/absences": {
"get": {
"tags": [
"Absence"
],
"description": "__Activity name :__ GetAbsencesByEmployeeId\n\nGet a list of all absences for the given employee\n",
"summary": "List of absences for an employee",
"operationId": "GetAbsencesByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2020-03-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/absencePutGetObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Absence"
],
"description": "__Activity name :__ PostAbsenceByEmployeeId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL. \n\nAdd an Absence (=verzuimmelding) for an employee. \n\n__Please note that if this endpoint is called successfully both an absence (=verzuimmelding) AND one underlying absence progress (=verzuimverloop) will be created.__\n",
"summary": "Create an Absence for an employee",
"operationId": "PostAbsenceByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add an Absence for an employee.",
"required": true,
"content": {
"application/json;version=2020-03-16": {
"schema": {
"$ref": "#/components/schemas/absencePostObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2020-03-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/absencePutGetObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/absences/{absenceId}": {
"get": {
"tags": [
"Absence"
],
"description": "__Activity name :__ GetAbsenceByAbsenceId\n\nGet the details of an Absence\n",
"summary": "Details of an Absence",
"operationId": "GetAbsenceByAbsenceId",
"parameters": [
{
"$ref": "#/components/parameters/absenceId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2020-03-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/absencePutGetObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Absence"
],
"description": "__Activity name :__ PutAbsenceByAbsenceId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n\nEdit the details of an Absence\n",
"summary": "Edit the details of an Absence",
"operationId": "PutAbsenceByAbsence",
"parameters": [
{
"$ref": "#/components/parameters/absenceId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Absence to edit.",
"required": true,
"content": {
"application/json;version=2020-03-16": {
"schema": {
"$ref": "#/components/schemas/absencePutGetObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2020-03-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/absencePutGetObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Absence"
],
"description": "__Activity name :__ DeleteAbsenceByAbsenceId\n\nDelete an existing absence (for an employee). If successful, this function also deletes the underlying absence progress records\n",
"summary": "Delete a specific absence record",
"operationId": "DeleteAbsenceByAbsenceId",
"parameters": [
{
"$ref": "#/components/parameters/absenceId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/absences/{absenceId}/closeabsence": {
"patch": {
"tags": [
"Absence"
],
"description": "__Activity name :__ PatchCloseAbsenceByAbsenceId\n\nA successful call to this endpoint will close the absence and the underlying absence progress (with an empty endDate).\n",
"summary": "Close an absence",
"operationId": "PatchCloseAbsenceByAbsenceId",
"parameters": [
{
"$ref": "#/components/parameters/absenceId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "The request body contains an object containing fields related to closing of an absence.",
"required": true,
"content": {
"application/json;version=2020-03-16": {
"schema": {
"$ref": "#/components/schemas/endOfAbsenceObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2020-03-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/absences/{absenceId}/reopenabsence": {
"patch": {
"tags": [
"Absence"
],
"description": "__Activity name :__ PatchReopenAbsenceByAbsenceId\n\nWhen performing a successful call to this endpoint, then the absence and the underlying absence progress will we reopend.\nBoth `endOfAbsenceDate` and `endOfAbsenceReason` will be set to null\n",
"summary": "Reopen an absence",
"operationId": "PatchReopenAbsenceByAbsenceId",
"parameters": [
{
"$ref": "#/components/parameters/absenceId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2020-03-16": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2020-03-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/absences/{absenceId}/absenceprogress": {
"get": {
"tags": [
"Absence Progress"
],
"description": "__Activity name :__ GetAbsenceProgressByAbsenceId\n\nGet a list of absence progress (verzuimverloop) for a specific absence (verzuimmelding).\n",
"summary": "List of absence progress for an absence",
"operationId": "GetAbsenceProgressByAbsenceId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/absenceId"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2020-03-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/absenceProgressObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Absence Progress"
],
"description": "__Activity name :__ PostAbsenceProgressByAbsenceId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL. \n\nAdd an Absence Progress (=Ziekteverloop) for an employee. As is common with closed chain entities, the endDate of the previous record will be filled depending on the startDate of the new one.\n\nPractically this means that a full recovery notification has been performed.\n",
"summary": "Create an Absence Progress for an Absence",
"operationId": "PostAbsenceProgressByAbsenceId",
"parameters": [
{
"$ref": "#/components/parameters/absenceId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add an Absence Progress for an Absence.",
"required": true,
"content": {
"application/json;version=2020-03-16": {
"schema": {
"$ref": "#/components/schemas/absenceProgressObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2020-03-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/absenceProgressObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/absences/absenceprogress/{absenceProgressId}": {
"get": {
"tags": [
"Absence Progress"
],
"description": "__Activity name :__ GetAbsenceProgressByAbsenceProgressId\n\nGet the details of an Absence Progress\n",
"summary": "Details of an Absence Progress",
"operationId": "GetAbsenceProgressByAbsenceProgressId",
"parameters": [
{
"$ref": "#/components/parameters/absenceProgressId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2020-03-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/absenceProgressObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Absence Progress"
],
"description": "__Activity name :__ PutAbsenceProgressByAbsenceProgressId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n\nEdit the details of an absence progress\n",
"summary": "Edit the details of an absence progress",
"operationId": "PutAbsenceProgressByAbsenceProgress",
"parameters": [
{
"$ref": "#/components/parameters/absenceProgressId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Absence progress to edit.",
"required": true,
"content": {
"application/json;version=2020-03-16": {
"schema": {
"$ref": "#/components/schemas/absenceProgressObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2020-03-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/absenceProgressObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Absence Progress"
],
"description": "__Activity name :__ DeleteAbsenceProgressByAbsenceProgressId\n\nDelete an existing Absence Progress (for an employee). There always has to remain one record of absence progress for an absence. This last record is removed when the absence is deleted.\n",
"summary": "Delete a specific Absence Progress record",
"operationId": "DeleteAbsenceProgressByAbsenceProgressId",
"parameters": [
{
"$ref": "#/components/parameters/absenceProgressId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/absences/{absenceId}/absencecontactHistory": {
"get": {
"tags": [
"Contact history"
],
"description": "__Activity name :__ GetAbsenceContactHistoryByAbsenceId\n\nGet the contacts history for a specific absence (verzuimmelding).\n",
"summary": "Contact history for an absence",
"operationId": "GetAbsenceContactsHistoryByAbsenceId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/absenceId"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/contactHistory"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Contact history"
],
"description": "__Activity name :__ PostAbsenceContactHistoryByAbsenceId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL. \n",
"summary": "Create a contact history for an Absence",
"operationId": "PostAbsenceContactHistoryByAbsenceId",
"parameters": [
{
"$ref": "#/components/parameters/absenceId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a record to the contact history for an absence.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/contactHistory"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/contactHistory"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/absences/absencecontactHistory/{absencecontactHistoryId}": {
"get": {
"tags": [
"Contact history"
],
"description": "__Activity name :__ GetAbsenceContactHistoryByAbsenceContactHistoryId\n\nGet the details of a contact \n",
"summary": "Details of a contact history",
"operationId": "GetAbsenceContactHistoryByAbsenceContactHistoryId",
"parameters": [
{
"$ref": "#/components/parameters/absencecontactHistoryId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2020-03-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/contactHistory"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Contact history"
],
"description": "__Activity name :__ PutAbsenceContactHistoryByAbsenceContactHistoryId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n\nEdit the details of a contact history\n",
"summary": "Edit the details of a contact history",
"operationId": "PutAbsenceContactHistoryByAbsenceContactHistoryId",
"parameters": [
{
"$ref": "#/components/parameters/absencecontactHistoryId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Absence progress to edit.",
"required": true,
"content": {
"application/json;version=2020-03-16": {
"schema": {
"$ref": "#/components/schemas/contactHistory"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2020-03-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/contactHistory"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Contact history"
],
"description": "__Activity name :__ DeleteAbsenceContactHistoryByAbsenceContactHistoryId\n\nDelete an existing record from the contact history\n",
"summary": "Delete a specific record",
"operationId": "DeleteAbsenceContactHistoryByAbsenceContactHistoryId",
"parameters": [
{
"$ref": "#/components/parameters/absencecontactHistoryId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/absences/statistics/data": {
"get": {
"tags": [
"Absence"
],
"description": "__Activity name :__ GetAbsenceStatisticsDataByEmployerId\n\nGet a basic overview of absence statistics for all employees of the given employer\n",
"summary": "basic absence statistics",
"operationId": "GetAbsenceStatisticsDataByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/startYearMonth"
},
{
"$ref": "#/components/parameters/endYearMonth"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/absenceStatisticsDataObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/administrations": {
"get": {
"tags": [
"Administration"
],
"description": "__Activity name :__ GetAdministrationsByEmployerId\n\nGet 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.\n",
"summary": "List of administrations for an employer",
"operationId": "GetAdministrationsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/administration"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/administrations": {
"get": {
"tags": [
"Administration"
],
"description": "__Activity name :__ GetAdministrationsByBearerToken
Get a list of all administrations (both payroll and non-payroll) the user has access to. For more detailed properties, use the respective endpoints for payroll and non-payroll administrations.
\n",
"summary": "List of administrations",
"operationId": "GetAdministrationsByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/administration"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/payrolladministrations": {
"get": {
"tags": [
"Payroll administration"
],
"description": "__Activity name :__ GetPayrollAdministrationsByEmployerId\n\nGet a list of all payroll administrations for an employer\n",
"summary": "List of payroll administrations for an employer",
"operationId": "GetPayrollAdministrationsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollAdministrationGet"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Payroll administration"
],
"description": "__Activity name :__ PostPayrollAdministrationByEmployerId\n\nAdd a payroll administration.\n",
"summary": "Add a payroll administration",
"operationId": "PostPayrollAdministrationByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Payroll administration",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/payrollAdministrationPost"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2020-03-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payrollAdministrationPostResponse"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}": {
"get": {
"tags": [
"Payroll administration"
],
"description": "__Activity name :__ GetPayrollAdministrationByPayrollAdministrationId\n\nGet the details of a single payroll administration\n",
"summary": "Details of a payroll administration",
"operationId": "GetPayrollAdministrationByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payrollAdministrationGet"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/payrolladministrations/configurations": {
"get": {
"tags": [
"Payroll administration"
],
"description": "__Activity name :__ GetPayrollAdministrationConfigurationsByEmployerId\n\nGet a list of all payroll administration configurations for an employer\n",
"summary": "List of payroll administrations configurations for an employer",
"operationId": "GetPayrollAdministrationConfigurationsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollAdministrationConfiguration"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/configurations": {
"get": {
"tags": [
"Payroll administration"
],
"description": "__Activity name :__ GetPayrollAdministrationConfigurationByPayrollAdministrationId\n\nGet the details of a single payroll administration configuration\n",
"summary": "Details of a payroll administration configuration",
"operationId": "GetPayrollAdministrationConfigurationByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payrollAdministrationConfiguration"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Payroll administration"
],
"description": "__Activity name :__ PutPayrollAdministrationConfigurationByPayrollAdministrationId\n\nEdit a non payroll administration. \n",
"summary": "Edit a payroll administration configuration",
"operationId": "PutPayrollAdministrationConfigurationByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/payrollAdministrationConfiguration"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payrollAdministrationConfiguration"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/automaticpayroll/payrolladministrations/{payrollAdministrationId}/automaticpayrollconfiguration": {
"get": {
"tags": [
"Automatic payroll configuration"
],
"description": "__Activity name :__ GetAutomaticPayrollConfigurationByPayrollAdministrationId\nThis endpoint retrieves the automatic payroll configuration for a given payroll administration.\n",
"summary": "Automatic payroll configuration",
"operationId": "GetAutomaticPayrollConfigurationByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/automaticPayrollConfiguration"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Automatic payroll configuration"
],
"description": "__Activity name :__ PatchAutomaticPayrollConfigurationByPayrollAdministrationId\nThis endpoint edits the automatic payroll configuration for a given payroll administration.\n",
"summary": "edit the automatic payroll configuration",
"operationId": "PatchAutomaticPayrollConfigurationByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Automatic payroll configuration",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/automaticPayrollConfiguration"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/automaticPayrollConfiguration"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/automaticpayroll/payrolladministrations/years/{yearId}/automaticpayrolldates": {
"get": {
"tags": [
"Automatic payroll dates"
],
"description": "__Activity name :__ GetAutomaticPayrollDatesByYearId\nThis endpoint retrieves the automatic payroll dates for a payroll administration and year. The YearId contains the year and the payroll administration id.\n",
"summary": "Automatic payroll dates",
"operationId": "GetAutomaticPayrollDatesByYearId",
"parameters": [
{
"$ref": "#/components/parameters/yearId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/automaticPayrollDates"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Automatic payroll dates"
],
"description": "__Activity name :__ PostAutomaticPayrollDateByYearId\nThis endpoint creates a new automatic payroll date for a given year.\n",
"summary": "create a new automatic payroll date",
"operationId": "PostAutomaticPayrollDateByYearId",
"parameters": [
{
"$ref": "#/components/parameters/yearId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Automatic payroll date details",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/automaticPayrollDatePost"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/automaticPayrollDates"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/automaticpayroll/payrolladministrations/years/automaticpayrolldates/{automaticPayrollDateId}": {
"patch": {
"tags": [
"Automatic payroll dates"
],
"description": "__Activity name :__ PatchAutomaticPayrollDateByAutomaticPayrollDateId\nThis endpoint edits an automatic payroll date.\n",
"summary": "edit an automatic payroll date",
"operationId": "PatchAutomaticPayrollDateByAutomaticPayrollDateId",
"parameters": [
{
"$ref": "#/components/parameters/automaticPayrollDateId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Automatic payroll configuration",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/automaticPayrollDatePut"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/automaticPayrollDates"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Automatic payroll dates"
],
"description": "__Activity name :__ DeleteAutomaticPayrollDateByAutomaticPayrollDateId\nThis endpoint deletes an automatic payroll date.\n",
"summary": "delete an automatic payroll date",
"operationId": "DeleteAutomaticPayrollDateByAutomaticPayrollDateId",
"parameters": [
{
"$ref": "#/components/parameters/automaticPayrollDateId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/authorizationmodel": {
"get": {
"tags": [
"AuthorizationModel"
],
"description": "__Activity name :__ GetAuthorizationModelByBearerToken\n\nGet a list of all activities with their associated authorizations, modules and roles.\n",
"summary": "The authorization model",
"operationId": "GetAuthorizationModelByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/authorizationModel"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/nonpayrolladministrations": {
"get": {
"tags": [
"Non payroll administration"
],
"description": "__Activity name :__ GetNonPayrollAdministrationsByEmployerId\n\nGet a list of all non payroll administrations for an employer\n",
"summary": "List of non payroll administrations for an employer",
"operationId": "GetNonPayrollAdministrationsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nonPayrollAdministration"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Non payroll administration"
],
"description": "__Activity name :__ PostNonPayrollAdministrationsByEmployerId\n\nAdd a non payroll administration.\n",
"summary": "Add a non payroll administration",
"operationId": "PostNonPayrollAdministrationsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "NonPayrollAdministration",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/nonPayrollAdministration"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"items": {
"$ref": "#/components/schemas/nonPayrollAdministration"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/nonpayrolladministrations/{nonPayrollAdministrationId}": {
"get": {
"tags": [
"Non payroll administration"
],
"description": "__Activity name :__ GetNonPayrollAdministrationByNonPayrollAdministrationId\n\nGet the details of a single non payroll administration\n",
"summary": "Details of a non payroll administration",
"operationId": "GetNonPayrollAdministrationByNonPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/nonPayrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/nonPayrollAdministration"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Non payroll administration"
],
"description": "__Activity name :__ PutNonPayrollAdministrationByNonPayrollAdministrationId\n\nEdit a non payroll administration. \n",
"summary": "Edit a non payroll administration",
"operationId": "PutNonPayrollAdministrationByNonPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/nonPayrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "PayrollComponentSet",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/nonPayrollAdministrationPut"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"items": {
"$ref": "#/components/schemas/nonPayrollAdministration"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/availablepayrollcomponentsets": {
"get": {
"tags": [
"Payroll component set"
],
"description": "__Activity name :__ GetAvailablePayrollComponentSetsByPayrollAdministrationId\nGet 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.\n\nBoth 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.\n",
"summary": "Available payroll component sets",
"operationId": "GetAvailablePayrollComponentSetsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"items": {
"$ref": "#/components/schemas/availablePayrollComponentSets"
}
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollcomponentsets": {
"get": {
"tags": [
"Payroll component set"
],
"description": "__Activity name :__ GetPayrollComponentSetsByPayrollAdministrationId\n\nGet the 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 constantly select the same set of payroll components. Payroll component sets are commonly used when entering payroll period data (variabele gegevens) either for a single employment or for multiple employments (browser variabele gegevens).\n",
"summary": "Payroll component sets",
"operationId": "GetPayrollComponentSetsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"items": {
"$ref": "#/components/schemas/payrollComponentSetsGetPost"
}
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Payroll component set"
],
"description": "__Activity name :__ PostPayrollComponentSetByPayrollAdministrationId\n\nAdd an payroll component set. \n",
"summary": "Add an Payroll component set",
"operationId": "PostPayrollComponentSetByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "PayrollComponentSet",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/payrollComponentSetsGetPost"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"items": {
"$ref": "#/components/schemas/payrollComponentSetsGetPost"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollcomponentsets/{payrollComponentSetId}": {
"get": {
"tags": [
"Payroll component set"
],
"description": "__Activity name :__ GetPayrollComponentSetsByPayrollComponentSetId\n\nGet the details of an payroll components sets. \n",
"summary": "Details of an payroll component set",
"operationId": "GetPayrollComponentSetsByPayrollComponentSetId",
"parameters": [
{
"$ref": "#/components/parameters/payrollComponentSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payrollComponentSetsGetPost"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Payroll component set"
],
"description": "__Activity name :__ PutPayrollComponentSetByPayrollComponentSetId\n\nEdit an payroll components set. \n",
"summary": "Edit an payroll component set",
"operationId": "PutPayrollComponentSetByPayrollComponentSetId",
"parameters": [
{
"$ref": "#/components/parameters/payrollComponentSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "PayrollComponentSet",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/payrollComponentSets"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"items": {
"$ref": "#/components/schemas/payrollComponentSetsGetPost"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Payroll component set"
],
"description": "__Activity name :__ DeletePayrollComponentSetByPayrollComponentSetId\n\nDelete an payroll component set. \n",
"summary": "Delete an Payroll component set",
"operationId": "DeletePayrollComponentSetByPayrollComponentSetId",
"parameters": [
{
"$ref": "#/components/parameters/payrollComponentSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/payrollcomponentsets": {
"get": {
"tags": [
"Payroll component set"
],
"description": "__Activity name :__ GetPayrollComponentSetsByProviderId\n\nGet the 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 constantly select the same set of payroll components. Payroll component sets are commonly used when entering payroll period data (variabele gegevens) either for a single employment or for multiple employments (browser variabele gegevens).\n",
"summary": "Payroll component sets (provider level)",
"operationId": "GetPayrollComponentSetsByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"items": {
"$ref": "#/components/schemas/payrollComponentSetsGetPost"
}
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Payroll component set"
],
"description": "__Activity name :__ PostPayrollComponentSetByProviderId\n\nAdd an payroll component set. \n",
"summary": "Add an Payroll component set (provider level)",
"operationId": "PostPayrollComponentSetByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "PayrollComponentSet",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/payrollComponentSetsGetPost"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"items": {
"$ref": "#/components/schemas/payrollComponentSetsGetPost"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/payrollcomponentsets/{payrollComponentSetId}": {
"get": {
"tags": [
"Payroll component set"
],
"description": "__Activity name :__ GetProviderPayrollComponentSetByPayrollComponentSetId\n\nGet the details of an payroll components sets. \n",
"summary": "Details of an payroll component set (provider level)",
"operationId": "GetProviderPayrollComponentSetByPayrollComponentSetId",
"parameters": [
{
"$ref": "#/components/parameters/payrollComponentSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payrollComponentSetsGetPost"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Payroll component set"
],
"description": "__Activity name :__ PutProviderPayrollComponentSetByPayrollComponentSetId\n\nEdit an payroll components set. \n",
"summary": "Edit an payroll component set (provider level)",
"operationId": "PutProviderPayrollComponentSetByPayrollComponentSetId",
"parameters": [
{
"$ref": "#/components/parameters/payrollComponentSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "PayrollComponentSet",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/payrollComponentSets"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"items": {
"$ref": "#/components/schemas/payrollComponentSetsGetPost"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Payroll component set"
],
"description": "__Activity name :__ DeleteProviderPayrollComponentSetByPayrollComponentSetId\n\nDelete an payroll component set. \n",
"summary": "Delete an Payroll component set (provider level)",
"operationId": "DeleteProviderPayrollComponentSetByPayrollComponentSetId",
"parameters": [
{
"$ref": "#/components/parameters/payrollComponentSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollcomponents/year/{year}": {
"get": {
"tags": [
"Payroll components"
],
"description": "__Activity name :__ GetPayrollComponentsByPayrollAdministrationIdAndYear\nGet the available payroll components for an administration.\n",
"summary": "Payroll components",
"operationId": "GetPayrollComponentsByPayrollAdministrationIdAndYear",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/year"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollComponents"
}
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/employmentfunds/year/{year}": {
"get": {
"tags": [
"Employment funds"
],
"description": "__Activity name :__ GetEmploymentFundsByPayrollAdministrationIdAndYear\n\nGet the available employment funds for an administration. \n",
"summary": "Employment funds for an administration",
"operationId": "GetEmploymentFundsByPayrollAdministrationIdAndYear",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/year"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employmentFunds"
}
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/abpfunds/year/{year}": {
"get": {
"tags": [
"Abp funds"
],
"description": "__Activity name :__ GetAbpFundsByPayrollAdministrationIdAndYear\n\nGet the available abp funds for an administration. \n",
"summary": "Abp funds for an administration",
"operationId": "GetAbpFundsByPayrollAdministrationIdAndYear",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/year"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/abpFunds"
}
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/users/collectiveactions": {
"get": {
"tags": [
"Collective action"
],
"description": "__Activity name :__ GetCollectiveActionsByBearerToken\n\nA list of collective actions for a user\n",
"summary": "List of collective actions for a user",
"operationId": "GetCollectiveActionsByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/collectiveAction"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/users/collectiveactions/{collectiveActionId}": {
"get": {
"tags": [
"Collective action"
],
"description": "__Activity name :__ GetCollectiveActionMessagesByCollectiveActionId\n\nGet the messages of all collectiveActionItems of a single collective action\n",
"summary": "List of messages of a collective action",
"operationId": "GetCollectiveActionMessagesByCollectiveActionId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/collectiveActionId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/collectiveActionDetail"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employmentActualMasterDataReport": {
"get": {
"tags": [
"Employer reports"
],
"description": "__Activity name :__ GetEmploymentActualMasterDataReportByEmployerId\n\nAcquire the actual master data report (Stamgegevens actueel) on employer level, as generated by the reporting service.\n",
"summary": "Download actual master data report (Stamgegevens actueel)",
"operationId": "GetEmploymentActualMasterDataReportByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/referenceDateRequired"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employmentMasterDataReport": {
"get": {
"tags": [
"Employer reports"
],
"description": "__Activity name :__ GetEmploymentMasterDataReportByEmployerId\n\nAcquire the master data report (Stamgegevens) on employer level, as generated by the reporting service.\n",
"summary": "Download master data report (Stamgegevens)",
"operationId": "GetEmploymentMasterDataReportByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/referenceDateRequired"
},
{
"$ref": "#/components/parameters/includeEmploymentsThatEndedBeforeReferenceDate"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/fiscalCompanyCarReport": {
"get": {
"tags": [
"Employer reports"
],
"description": "__Activity name :__ GetFiscalCompanyCarReportByEmployerId\n\nAcquire the fiscal company car report (Auto van de zaak) on employer level, as generated by the reporting service.\n",
"summary": "Download the fiscal company car report (Auto van de zaak)",
"operationId": "GetFiscalCompanyCarReportByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/referenceDateRequired"
},
{
"$ref": "#/components/parameters/includeEmploymentsThatEndedBeforeReferenceDate"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/annualpayrolltaxreturnreport": {
"get": {
"tags": [
"Payroll administration reports"
],
"description": "__Activity name :__ GetAnnualPayrollTaxReturnReportByPayrollAdministrationId\n\nAcquire the annual payroll tax return report (jaaroverzicht loongaangiftestaat) on payroll administration level, as generated by the reporting service.\n\n_Please note: this endpoint may only be used to acquire a report in the pdf-type format_ \n",
"summary": "Download annual payroll tax return report",
"operationId": "GetAnnualPayrollTaxReturnReportByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/reportYear"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/annualwagesheetreport": {
"get": {
"tags": [
"Payroll administration reports"
],
"description": "__Activity name :__ GetAnnualWagesheetReportByPayrollAdministrationId\n\nAcquire the annual wage sheet report (verzamelloonstaat) on payroll administration level, as generated by the reporting service.\n\n__Note: __ For the querystring parameters take note of the following logic either reportYear has a value or start and endperiod have a value\n",
"summary": "Download annual wage sheet report",
"operationId": "GetAnnualWagesheetReportByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/reportYearNotRequired"
},
{
"$ref": "#/components/parameters/startPeriodNotRequired"
},
{
"$ref": "#/components/parameters/endPeriodNotRequired"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrolladministrationsettingsreport": {
"get": {
"tags": [
"Payroll administration reports"
],
"description": "__Activity name :__ GetPayrollAdministrationSettingsReportByPayrollAdministrationId\n\nAcquire the payroll administration configuration report (overzicht inrichting salarisverwerking) on payroll administration level for a year, as generated by the reporting service.\n\n_Please note: this endpoint may only be used to acquire a report in the pdf-type format_ \n",
"summary": "Download payroll administration configuration report",
"operationId": "GetPayrollAdministrationSettingsReportByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/reportYear"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/accumulationsandbalancesreport": {
"get": {
"tags": [
"Payroll administration reports"
],
"description": "__Activity name :__ GetAccumulationsAndBalancesReportByPayrollAdministrationId\n\nAcquire the reports for either accumulations or balances at the payroll administration level. Currently this endpoint supports following report types to be requested:\n* baseForCalculationBalancesAtStartOfYear (grondslag begin jaar)\n\n* leaveBalancesAtStartOfYear (verlof begin jaar)\n\n* leaveAccrualWithinYear (opbouw verlof ulsa)\n",
"summary": "Download accumulations and balances reports",
"operationId": "GetAccumulationsAndBalancesReportByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/reportTypeAccumulationsAndBalances"
},
{
"$ref": "#/components/parameters/reportYear"
},
{
"$ref": "#/components/parameters/includeEmploymentsThatEndedBeforeStartOfTheYear"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/accumulatedbasicjournalresultsreport": {
"get": {
"tags": [
"Payroll administration reports"
],
"description": "__Activity name :__ GetAccumulatedBasicJournalResultsReportByPayrollAdministrationId\n\nAcquire 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:\n\n_Please note: this endpoint may only be used to acquire a report in the pdf-type format_ \n",
"summary": "Download accumulated basic journal results report",
"operationId": "GetAccumulatedBasicJournalResultsReportByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/reportTypeAccumulatedJournalRunResults"
},
{
"$ref": "#/components/parameters/groupingTypeAccumulatedJournalRunResults"
},
{
"$ref": "#/components/parameters/startPeriod"
},
{
"$ref": "#/components/parameters/endPeriod"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/deviatingpremiumswab": {
"get": {
"tags": [
"Payroll administration reports"
],
"description": "__Activity name :__ GetDeviatingPremiumsWabReportByPayrollAdministrationId\n\nThe 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.\n",
"summary": "Download WAB deviations report",
"operationId": "GetDeviatingPremiumsWabReportByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/reportYear"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/attachmentsofearningsreport": {
"get": {
"tags": [
"Payroll administration reports"
],
"description": "__Activity name :__ GetAttachmentsOfEarningsReportByPayrollAdministrationId\n\nDownload the attachment of earnings report for the administration\n",
"summary": "Download attachment of earnings report",
"operationId": "GetAttachmentsOfEarningsReportByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/reportYear"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/accumulatedjournalrunresultsreport\"": {
"get": {
"tags": [
"Payroll administration reports"
],
"description": "__Activity name :__ GetAccumulatedJournalRunResultsReportByPayrollAdministrationId\n\nAcquire accumulated journalrun results report (CSV) at the payroll administration level. \n",
"summary": "Download accumulated journalrun results report",
"operationId": "GetAccumulatedJournalRunResultsReportByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/startPeriod"
},
{
"$ref": "#/components/parameters/endPeriod"
},
{
"$ref": "#/components/parameters/reportJournalNumber"
},
{
"$ref": "#/components/parameters/reportVoucherNumber"
},
{
"$ref": "#/components/parameters/reportDescription"
},
{
"$ref": "#/components/parameters/financialYear"
},
{
"$ref": "#/components/parameters/period"
},
{
"$ref": "#/components/parameters/date"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriodDataReport": {
"get": {
"tags": [
"Payroll administration reports"
],
"description": "__Activity name :__ GetPayrollPeriodDataReportByPayrollAdministrationId\n\nAcquire the payroll period data report (Variabele gegevens per periode) on payroll administration level, as generated by the reporting service.\n",
"summary": "Download annual wage sheet report",
"operationId": "GetPayrollPeriodDataReportByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollPeriodId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/PayrollAuditReport\"": {
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/reportYear"
}
],
"get": {
"tags": [
"Payroll administration reports"
],
"description": "__Activity name :__ GetPayrollAuditReportByPayrollAdministrationId\n\nAcquire the payroll audit report (Auditfile Salaris (XAS), formaly known in loket as the XML audit file) on payroll administration level.\nThis report is only for the year 2024 and later. The report is generated in the XAS format as specified by the Belastingdienst.\n",
"summary": "Download payroll audit report",
"operationId": "GetPayrollAuditReportByPayrollAdministrationId",
"responses": {
"200": {
"description": "OK",
"content": {
"application/xml": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/employmentActualMasterDataReport": {
"get": {
"tags": [
"Employment reports"
],
"description": "__Activity name :__ GetEmploymentActualMasterDataReportByEmploymentId\n\nAcquire the actual master data report (Stamgegevens actueel) on employment level, as generated by the reporting service.\n",
"summary": "Download actual master data report (Stamgegevens actueel)",
"operationId": "GetEmploymentActualMasterDataReportByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/referenceDateRequired"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/employmentMasterDataReport": {
"get": {
"tags": [
"Employment reports"
],
"description": "__Activity name :__ GetEmploymentMasterDataReportByEmploymentId\n\nAcquire the master data report (Stamgegevens) on employment level, as generated by the reporting service.\n",
"summary": "Download master data report (Stamgegevens)",
"operationId": "GetEmploymentMasterDataReportByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/{payrollPeriodId}/payrollperioddata": {
"get": {
"tags": [
"Payroll period data on administration level"
],
"description": "__Activity name :__ GetPayrollPeriodDataByPayrollAdministrationIdAndPayrollPeriodId\n\nGet 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.\n\nThis 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.\n\n__Metadata :__ Possible options for the query string parameters can be acquired (GET) via the `/metadata` endpoint. The URI for this endpoint is `../v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/payrollperioddata/metadata`.\n\n__Defaults :__ Default values for the query string parameters can be acquired via the `/defaults` endpoint. The URI for this endpoint is `../v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/payrollperioddata/defaults`.\n",
"summary": "List of payroll period data on payroll administration level",
"operationId": "GetPayrollPeriodDataByPayrollAdministrationIdAndPayrollPeriodId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/payrollPeriodId-2"
},
{
"$ref": "#/components/parameters/payslipType"
},
{
"$ref": "#/components/parameters/payrollComponentSet"
},
{
"$ref": "#/components/parameters/payrollComponentCategory"
},
{
"$ref": "#/components/parameters/payrollComponentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollData"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/payrollcomponent/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/{payrollPeriodId}/payrollperioddata/smartpaste": {
"post": {
"tags": [
"Smart Paste payroll period data"
],
"description": "__Activity name :__ PostInitiateSmartPasteByPayrollAdministrationIdAndPayrollPeriodId\n\nInitiate a Smart Paste operation on payroll period data for all active employments in the given payroll period for the given payroll administration. \n",
"summary": "Initiate a Smart Paste on payroll period data on administration level",
"operationId": "PostInitiateSmartPasteByPayrollAdministrationIdAndPayrollPeriodId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/payrollPeriodId-3"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Smart Paste data to be processed.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/smartPasteData"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object",
"properties": {
"transactionId": {
"$ref": "#/components/schemas/id"
}
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/payrollcomponent/providers/employers/payrolladministrations/payrollPeriods/payrollperioddata/smartpaste/{smartPasteId}": {
"get": {
"tags": [
"Smart Paste payroll period data"
],
"description": "__Activity name :__ GetPayrollPeriodDataSmartPasteResultsBySmartPasteId\n\nGet the results of a Smart Paste operation on payroll period data.\n",
"summary": "Results of Smart Paste on payroll period data",
"operationId": "GetPayrollPeriodDataSmartPasteResultsBySmartPasteId",
"parameters": [
{
"$ref": "#/components/parameters/smartPasteId"
},
{
"$ref": "#/components/parameters/employerId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/smartPasteResults"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/import/payrollperioddata\"": {
"post": {
"tags": [
"Payroll period data"
],
"description": "__Activity name :__ PostPayrollPeriodImportDataByPayrollAdministrationId
import payroll period data records for an employer
\n",
"summary": "Import payroll period data for an employer",
"operationId": "PostPayrollPeriodImportDataByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollPeriodIdQuery"
},
{
"$ref": "#/components/parameters/payslipType"
},
{
"$ref": "#/components/parameters/processingMethod"
}
],
"requestBody": {
"description": "csv file to be uploaded.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/importFile"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/import/payrollperioddata\"": {
"post": {
"tags": [
"Payroll period data"
],
"description": "__Activity name :__ PostPayrollPeriodImportDataByBearerToken
import payroll period data records for several employees from sereval employers at once.
\n",
"summary": "Import payroll period data for several employers",
"operationId": "PostPayrollPeriodImportDataByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollPeriodIdQuery"
},
{
"$ref": "#/components/parameters/payslipType"
},
{
"$ref": "#/components/parameters/processingMethod"
}
],
"requestBody": {
"description": "csv file to be uploaded.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/importFile"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/workflowtriggers": {
"get": {
"tags": [
"Workflow trigger"
],
"description": "__Activity name:__ GetWorkflowTriggersByEmployerId\nFetches a list of workflow triggers available for a given employer. Workflow triggers are events that initiate workflows. This endpoint allows clients to query triggers associated with an employer.\n",
"summary": "Get Workflow Triggers by Employer ID",
"operationId": "GetWorkflowTriggersByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/workflowTrigger"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/workflowtriggers/workflowtemplates/{workflowTemplateId}": {
"get": {
"tags": [
"Workflow template"
],
"description": "__Activity name:__ GetWorkflowTemplateByWorkflowTemplateId\n\nGet a workflow template by its ID. Workflow templates define what happens when a workflow is triggered.\n",
"summary": "Get Workflow Template",
"operationId": "GetWorkflowTemplateByWorkflowTemplateId",
"parameters": [
{
"$ref": "#/components/parameters/workflowTemplateId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/workflowTemplate"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Workflow template"
],
"description": "__Activity name:__ PutWorkflowTemplateByWorkflowTemplateId\n\nEdit a workflow template. Workflow templates define what happens when a workflow is triggered.\n\nPossible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n",
"summary": "Edit a workflow template",
"operationId": "PutWorkflowTemplateByWorkflowTemplateId",
"parameters": [
{
"$ref": "#/components/parameters/workflowTemplateId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "The workflow template to update.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/workflowTemplate"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/workflowTemplate"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Workflow template"
],
"description": "__Activity name:__ DeleteWorkflowTemplateByWorkflowTemplateId\n\nDelete a workflow template for a workflow trigger. Workflow templates define what happens when a workflow is triggered.\n",
"summary": "Delete a workflow template",
"operationId": "DeleteWorkflowTemplateByWorkflowTemplateId",
"parameters": [
{
"$ref": "#/components/parameters/workflowTemplateId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/workflowtriggers/{workflowTriggerId}/workflowtemplates": {
"post": {
"tags": [
"Workflow template"
],
"description": "__Activity name:__ PostWorkflowTemplateByEmployerIdAndWorkflowTriggerId\n\nCreates a new workflow template for a given employer and workflow trigger. Workflow templates define what happens when a workflow is triggered.\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL. __Defaults :__ The default workflow template for the given workflow trigger can be acquired (GET) by adding `/defaults` to the POST URL.\n",
"summary": "Create a workflow template for a given employer and workflow trigger",
"operationId": "PostWorkflowTemplateByEmployerIdAndWorkflowTriggerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/workflowTriggerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "The workflow template to create.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/workflowTemplate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/workflowTemplate"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/workflowtriggermappings": {
"get": {
"tags": [
"Workflow trigger mapping"
],
"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.
\n",
"summary": "Workflowtrigger to workflowtemplate mapping",
"operationId": "GetWorkflowTriggerMappingsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/workflowTriggerMapping"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Workflow trigger mapping"
],
"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.
\n",
"summary": "Create a workflow trigger mapping record for an employer",
"operationId": "PostWorkflowTriggerMappingByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Workflow triggers record to add to the employer.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/workflowTriggerMapping"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/workflowTriggerMapping"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/workflowtriggermappings/{workflowTriggerMappingId}": {
"get": {
"tags": [
"Workflow trigger mapping"
],
"description": "__Activity name:__ GetWorkflowTriggerMappingByWorkflowTriggerMappingId\n\nGet the details of a workflow trigger mapping\n",
"summary": "Details of a workflow trigger mapping record",
"operationId": "GetWorkflowTriggerMappingByWorkflowTriggerMappingId",
"parameters": [
{
"$ref": "#/components/parameters/workflowTriggerMappingId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/workflowTriggerMapping"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Workflow trigger mapping"
],
"description": "__Activity name:__ PutWorkflowTriggerMappingByWorkflowTriggerMappingId\n\nEdit the details for a workflow trigger mapping record\n\nPossible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n",
"summary": "Edit the details of a workflow trigger mapping record",
"operationId": "PutWorkflowTriggerByWorkflowTriggerId",
"parameters": [
{
"$ref": "#/components/parameters/workflowTriggerMappingId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Workflow trigger to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/workflowTriggerMapping"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/workflowTriggerMapping"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Workflow trigger mapping"
],
"description": "__Activity name:__ DeleteWorkflowTriggerMappingByWorkflowTriggerMappingId\n\nDelete a workflow trigger mapping record for the employer\n",
"summary": "Delete a specific workflow trigger mapping record",
"operationId": "DeleteFiscalPropertiesByworkflowTriggerId",
"parameters": [
{
"$ref": "#/components/parameters/workflowTriggerMappingId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/changeaddressrequest": {
"post": {
"tags": [
"Change address request"
],
"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.
\n",
"summary": "Start the change address workflow for an employee",
"operationId": "PostChangeAddressRequestByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Data to as input for the workflow (the new address)",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/changeAddressRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/changeAddressResponse"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/changecontactinformationrequest": {
"post": {
"tags": [
"Change contactinformation request"
],
"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.
\n",
"summary": "Start the change contactinformation workflow for an employee",
"operationId": "PostChangeContactInformationRequestByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Data to serve as input for the workflow (the new contactinformation)",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/changeContactInformationRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/changeContactInformationResponse"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/workflow/InitiateChangeAddress": {
"post": {
"tags": [
"Workflow employee"
],
"description": "__Activity name:__ PostInitiateChangeAddressWorkflowByEmployeeId
Allows the user to trigger a workflow to change an address for an employee. The workflow may 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 :__ none
\n",
"summary": "Initiate the change address workflow for an employee",
"operationId": "PostInitiateChangeAddressWorkflowByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Input for the workflow (the new address)",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/changeAddressRequest-2"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/changeAddressResponse"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/workflow/InitiateChangeContactInformation": {
"post": {
"tags": [
"Workflow employee"
],
"description": "__Activity name:__ PostInitiateChangeContactInformationWorkflowByEmployeeId
Allows the user to trigger a workflow to change the contact information for an employee. The workflow may require the change to be approved.
__Metadata :__ none
__Defaults :__ none
\n",
"summary": "Initiate the change contact information workflow for an employee",
"operationId": "PostInitiateChangeContactInformationWorkflowByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Input for the workflow",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/changeContactInformationRequest-2"
}
}
}
},
"responses": {
"202": {
"$ref": "#/components/responses/acceptedResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/workflow/InitiateChangePersonalInformation": {
"post": {
"tags": [
"Workflow employee"
],
"description": "__Activity name:__ PostInitiateChangePersonalInformationWorkflowByEmployeeId
Allows the user to trigger a workflow to change his personal information for an employee. The workflow may 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 :__ none
\n",
"summary": "Initiate the change personal information workflow for an employee",
"operationId": "PostInitiateChangePersonalInformationWorkflowByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Input for the workflow",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/changePersonalInformationRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/changePersonalInformationResponse"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/workflow/InitiateManagePartners": {
"post": {
"tags": [
"Workflow employee"
],
"description": "__Activity name:__ PostInitiateManagePartnersWorkflowByEmployeeId
Allows the user to trigger a workflow to manage the partners (Create, update and delete). The workflow may 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 :__ none
\n",
"summary": "Initiate the change partner information workflow for an employee",
"operationId": "PostInitiateManagePartnersWorkflowByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Input for the workflow",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/create"
},
{
"$ref": "#/components/schemas/update"
},
{
"$ref": "#/components/schemas/delete"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/response"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/workflow/InitiateManageContacts": {
"post": {
"tags": [
"Workflow employee"
],
"description": "__Activity name:__ PostInitiateManageContactsWorkflowByEmployeeId
Allows the user to trigger a workflow to manage his contact information (Create, update and delete). The workflow may 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 :__ none
\n",
"summary": "Initiate the manage contact workflow for an employee",
"operationId": "PostInitiateManageContactsWorkflowByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Input for the workflow",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/create-2"
},
{
"$ref": "#/components/schemas/update-2"
},
{
"$ref": "#/components/schemas/delete-2"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/response"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/workflow/InitiateDeclaration": {
"post": {
"tags": [
"Workflow employment"
],
"description": "__Activity name:__ PostInitiateDeclarationWorkflowByEmploymentId
Allows the user to trigger a workflow to start a declaration for an employment. The workflow may 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 :__ none
\n",
"summary": "Initiate the declaration workflow for an employment",
"operationId": "PostInitiateDeclarationWorkflowByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Input for the workflow!",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/declarationRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/declarationResponse"
}
}
}
]
},
"examples": {
"withoutRoute": {
"$ref": "#/components/examples/withoutRoute"
},
"withRoute": {
"$ref": "#/components/examples/withRoute"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/workflow/{workflowId}/initiatedDeclaration": {
"patch": {
"tags": [
"Workflow employment"
],
"description": "__Activity name:__ PatchInitiatedDeclarationWorkflowByWorkflowId
\nAllows the user to change the initial values of a declaration workflow. Changes are only allowed so long as no other actor has made any changes for the workflow. e.g. If an user has already approved initial information, it can no longer be changed. To determine if it is allowed to make changes, please see field `canBeEditedByInitiator` in the workflow object.\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ none",
"summary": "Change the details of a declaration",
"operationId": "PatchInitiatedDeclarationWorkflowByWorkflowId",
"parameters": [
{
"$ref": "#/components/parameters/workflowId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Input for the workflow",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/declarationRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/declarationResponse"
}
}
}
]
},
"examples": {
"withoutRoute": {
"$ref": "#/components/examples/withoutRoute"
},
"withRoute": {
"$ref": "#/components/examples/withRoute"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/workflow/InitiateChangeIban": {
"post": {
"tags": [
"Workflow employment"
],
"description": "__Activity name:__ PostInitiateChangeIbanWorkflowByEmploymentId\n\nAllows the user to trigger a workflow to change the IBAN (that is used to payout the net wage) for an employment.\nThe workflow may require the change to be approved.\n\n__Metadata :__ no 'metadata' \n\n__Defaults :__ none",
"summary": "Initiate the change IBAN workflow for an employment",
"operationId": "PostInitiateChangeIbanWorkflowByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Input for the workflow",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/changeIbanRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ibanResponse"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/workflow/InitiateLeaveRequest": {
"post": {
"tags": [
"Workflow employment"
],
"description": "__Activity name:__ PostInitiateLeaveRequestWorkflowByEmploymentId
Allows the user to trigger a workflow to start a leave request for an employment. The workflow may 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 :__ none
\n",
"summary": "Initiate the leave request workflow for an employment",
"operationId": "PostInitiateLeaveRequestWorkflowByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Input for the workflow",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/leaveRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/workflow/{workflowId}/InitiatedLeaveRequest": {
"patch": {
"tags": [
"Workflow employment"
],
"description": "__Activity name:__ PatchInitiatedLeaveRequestWorkflowByWorkflowId
\nAllows the user to change the initial values of a leave request workflow. Changes are only allowed so long as no other actor has made any changes for the workflow. e.g. If an user has already approved initial information, it can no longer be changed. To determine if it is allowed to make changes, please see field `canBeEditedByInitiator` in the workflow object.\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) via `/v2/providers/employers/employees/employments/{employmentId}/leaverequests/metadata`.\n\n__Defaults :__ none",
"summary": "Change the details of a leave request",
"operationId": "PatchInitiatedLeaveRequestWorkflowByWorkflowId",
"parameters": [
{
"$ref": "#/components/parameters/workflowId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Input for the workflow",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/leaveRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/leaveRequests/{leaveRequestId}/workflow/WithdrawLeaveRequest": {
"post": {
"tags": [
"Workflow employment"
],
"description": "__Activity name:__ PostInitiateWithdrawApprovedLeaveRequestWorkflowByLeaveRequestId
Allows the user to trigger a workflow to start the withdrawal of an approved leave request. The workflow may require the change to be approved.\n",
"summary": "Initiate the withdraw leave request workflow for a leave request",
"operationId": "PostInitiateWithdrawApprovedLeaveRequestWorkflowByLeaveRequestId",
"parameters": [
{
"$ref": "#/components/parameters/leaveRequestId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employmentIdQuery"
}
],
"requestBody": {
"description": "Input for the workflow",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/withdrawLeaveRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/workflow/InitiateDocumentRequest": {
"post": {
"tags": [
"Workflow employment"
],
"description": "__Activity name:__ PostInitiateDocumentRequestWorkflowByEmploymentId
Allows the user to trigger a workflow to request a document for an employment (by employmentId). The workflow may require the change to be approved.
__Defaults :__ none
\n",
"summary": "Initiate the document request workflow for an employment",
"operationId": "PostInitiateDocumentRequestWorkflowByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Input for the workflow (requested document)",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employmentDocumentRequestRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employmentDocumentRequestResponse"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/workflows/initiatecontractextension": {
"post": {
"tags": [
"Workflow employment"
],
"description": "__Activity name:__ PostInitiateContractExtensionWorkflowByEmploymentId
Allows the loket user to trigger a workflow to change the contract for an employment. The workflow may require the change to be approved.
\n",
"summary": "Initiate the contract extension workflow for an employment",
"operationId": "PostInitiateContractExtensionWorkflowByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Input for the workflow (the new contract details)",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/contractExtensionRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/contractExtensionResponse"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/workflows/initiateterminateemployment": {
"post": {
"tags": [
"Workflow employment"
],
"description": "__Activity name:__ PostInitiateTerminateEmploymentWorkflowByEmploymentId
Allows the loket user to trigger a workflow to terminate an employment contract. The workflow may require approval.
\n",
"summary": "Initiate the employment termination workflow",
"operationId": "PostInitiateTerminateEmploymentWorkflowByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Input for the workflow (termination details)",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/terminateEmploymentRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/terminateEmploymentResponse"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/workflow/{workflowId}/attachment": {
"get": {
"tags": [
"Workflow employment"
],
"description": "__Activity name :__ GetDeclarationAttachmentByWorkflowId\n\nDownload the attachment (via Qwoater) for the given declaration workflowId. In case no attachment is know the service will return a 404.\n",
"summary": "Download attachment",
"operationId": "GetDeclarationAttachmentByWorkflowId",
"parameters": [
{
"$ref": "#/components/parameters/workflowId"
},
{
"$ref": "#/components/parameters/authorization"
}
],
"responses": {
"200": {
"description": "OK. Output type may be of any extension type that is supported by Qwoater."
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Workflow employment"
],
"description": "__Activity name :__ PostDeclarationAttachmentByWorkflowId\n\nUpload an attachment to a declaration workflow. Via Qwoater.\n",
"summary": "Upload attachment",
"operationId": "PostDeclarationAttachmentByWorkflowId",
"parameters": [
{
"$ref": "#/components/parameters/workflowId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Document to be uploaded as attachment to the declaration.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/attachmentPostObject"
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/qwoatermicroservice/providers/employers/employees/employments/{employmentId}/workflows/withattachment": {
"get": {
"tags": [
"Workflow employment"
],
"description": "__Activity name :__ GetWorkflowsWithAttachmentByEmploymentId\n\nGet a list of all declarationId's of declarations that have an attachment to it.\n\nThe 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.\n\nIf an attachment is available then a call may be performed to the attachment download endpoint to actually start downloading the attachment for this declaration.\n",
"summary": "Check if a list of workflowId's for an employment have an attachment",
"operationId": "GetWorkflowsWithAttachmentByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/workflowIds"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/workflowIds"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/qwoatermicroservice/providers/employers/{employerId}/employees/employments/workflows/withattachment": {
"get": {
"tags": [
"Workflow employment"
],
"summary": "Check if a list of workflowId's for an employer have an attachment",
"description": "__Activity name :__ GetWorkflowsWithAttachmentByEmployerId\n\nThis endpoint returns from a set of workflow IDs, the workflow Ids for which an attachment is available\n\nAll declarationIds must belong to the same employerId.\n\nAttachments are 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.\n",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/workflowIds"
}
],
"operationId": "GetWorkflowsWithAttachmentByEmployerId",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/workflowIds"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/workflows/{workflowId}/cancel": {
"patch": {
"tags": [
"Workflows"
],
"description": "__Activity name :__ PatchCancelWorkflowByWorkflowId\n\nAllows the employee to cancel the workflow. Cancelation is only allowed when no actions have yet been taken for the workflow.\n",
"summary": "Cancel a workflow",
"operationId": "PatchCancelWorkflowByWorkflowId",
"parameters": [
{
"$ref": "#/components/parameters/workflowId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/assignedworkflows": {
"get": {
"tags": [
"Workflows"
],
"description": "__Activity name:__ GetAssignedWorkflowsByEmployerId
Get the list workflows that are assigned to the user or the role of the user.
\n",
"summary": "Workflows assigned to the user",
"operationId": "GetAssignedWorkflowsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/workflows"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/users/initiatedworkflows": {
"get": {
"tags": [
"Workflows"
],
"description": "__Activity name:__ GetInitiatedWorkflowsByBearerToken
Get the workflows that are initiated by the user.
\n",
"summary": "Workflows initiated by the user",
"operationId": "GetInitiatedWorkflowsByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/workflowFilters"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/workflows"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/workflows": {
"get": {
"tags": [
"Workflows"
],
"description": "__Activity name:__ GetWorkflowsByEmployerId
Get the list of all workflows for an employer. All as in both open as finished workflows are returned.
\n",
"summary": "Workflows for the employer",
"operationId": "GetWorkflowsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/workflows"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/workflows/{workflowId}": {
"get": {
"tags": [
"Workflows"
],
"description": "__Activity name:__ GetWorkflowByWorkflowId\n\nGet the details of a workflow \n",
"summary": "Details of a workflow",
"operationId": "GetWorkflowByWorkflowId",
"parameters": [
{
"$ref": "#/components/parameters/workflowId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/workflows"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/workflows/{workflowId}/transition": {
"post": {
"tags": [
"Workflows"
],
"description": "__Activity name:__ PostTransitionWorkflowByWorkflowId
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.\n",
"summary": "Allows the user to transition the workflow.",
"operationId": "PostTransitionWorkflowByWorkflowId",
"parameters": [
{
"$ref": "#/components/parameters/workflowId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/transition"
},
"examples": {
"approve": {
"$ref": "#/components/examples/approve"
},
"reject": {
"$ref": "#/components/examples/reject"
},
"inputData": {
"$ref": "#/components/examples/inputData"
}
}
}
}
},
"responses": {
"202": {
"$ref": "#/components/responses/acceptedResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/workflows": {
"get": {
"tags": [
"Workflows"
],
"description": "__Activity name:__ GetWorkflowsByEmploymentId
Get the list of all workflows for an employment. Both open and completed workflows are returned.
\n",
"summary": "Workflows for the employment",
"operationId": "GetWorkflowsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/workflows"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/workflows/{workflowId}/workflowprogress": {
"get": {
"tags": [
"Workflow progress"
],
"summary": "Progress of a Workflow",
"description": "Gets the workflowProgres of a specific workflow",
"operationId": "GetWorkflowProgressByWorkflowId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/workflowId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/workflowprogress"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees": {
"get": {
"tags": [
"Employee"
],
"description": "__Activity name :__ GetEmployeesByEmployerId\n\nGet a list of all employees for the given employer\n",
"summary": "List of employees for an employer",
"operationId": "GetEmployeesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/acceptWithExport"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/X-ReportInput"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2021-03-29": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employee2021-03-29"
}
}
}
}
]
}
},
"application/json;version=2018-12-31": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employee2018-12-31"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}": {
"get": {
"tags": [
"Employee"
],
"description": "__Activity name :__ GetEmployeeByEmployeeId\n\nGet the details of a single employee\n",
"summary": "Details of an employee",
"operationId": "GetEmployeeByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2021-03-29": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employee2021-03-29"
}
}
}
]
}
},
"application/json;version=2018-12-31": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employee2018-12-31"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Employee"
],
"description": "__Activity name :__ PutEmployeeByEmployeeId\n\n\nEdit the employee details\n
\nPossible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the URL\n",
"summary": "Edit the details of an employee",
"operationId": "PutEmployeeByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Employee to edit.",
"required": true,
"content": {
"application/json;version=2021-03-29": {
"schema": {
"$ref": "#/components/schemas/employee2021-03-29"
}
},
"application/json;version=2018-12-31": {
"schema": {
"$ref": "#/components/schemas/employee2018-12-31"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2021-03-29": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employee2021-03-29"
}
}
}
]
}
},
"application/json;version=2018-12-31": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employee2018-12-31"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Employee"
],
"description": "__Activity name :__ PatchEmailByEmployeeId\n\n__Defaults :__ No defaults\n",
"summary": "Change the email address for an employee",
"operationId": "PatchEmailByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Email address",
"required": true,
"content": {
"application/json;version=2018-12-31": {
"schema": {
"$ref": "#/components/schemas/emailAddress"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/contacts": {
"get": {
"tags": [
"Contact"
],
"description": "__Activity name :__ GetContactsByEmployeeId\n\nGet list of contacts for an employee\n",
"summary": "List of contacts for an employee",
"operationId": "GetContactsByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employeeContact"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Contact"
],
"description": "__Activity name :__ PostContactByEmployeeId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ No default values\n\nCreate a new contact for an employee\n",
"summary": "Create a contact for an employee",
"operationId": "PostContactByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Contact to add to the employee.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employeeContact"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employeeContact"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/contacts/{contactId}": {
"get": {
"tags": [
"Contact"
],
"description": "__Activity name :__ GetContactByContactId \n\nGet the details of a single contact\n",
"summary": "Details of a single contact",
"operationId": "GetContactByContactId",
"parameters": [
{
"$ref": "#/components/parameters/employeeContactId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employeeContact"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Contact"
],
"description": "__Activity name :__ PutContactByContactId \n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n\nEdit the details of a contact\n",
"summary": "Edit a contact",
"operationId": "PutContactByContactId",
"parameters": [
{
"$ref": "#/components/parameters/employeeContactId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Contact to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employeeContact"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employeeContact"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Contact"
],
"description": "__Activity name :__ DeleteContactByContactId\n\nDelete an existing Contact (for an employee)\n",
"summary": "Delete a specific contact",
"operationId": "DeleteContactByContactId",
"parameters": [
{
"$ref": "#/components/parameters/employeeContactId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/children": {
"get": {
"tags": [
"Child"
],
"description": "__Activity name :__ GetChildrenByEmployeeId\n\n\n Get the list of children of the employee\n",
"summary": "List of children for an employee",
"operationId": "GetChildrenByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/child"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Child"
],
"description": "__Activity name :__ PostChildByEmployeeId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL. \n\nAdd a child for an employee\n",
"summary": "Create an child for an employee",
"operationId": "PostChildByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a child for an employee.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/child"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/child"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/children/{childId}": {
"get": {
"tags": [
"Child"
],
"description": "__Activity name :__ GetChildByChildId\n\nGet the details of a child \n",
"summary": "Details of a child",
"operationId": "GetChildByChildId",
"parameters": [
{
"$ref": "#/components/parameters/childId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/child"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Child"
],
"description": "__Activity name :__ PutChildByChildId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n\nEdit the details of a child\n",
"summary": "Edit the details of a child",
"operationId": "PutChildByChildId",
"parameters": [
{
"$ref": "#/components/parameters/childId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Child to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/child"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/child"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Child"
],
"description": "__Activity name :__ DeleteChildByChildId\n\nDelete an existing child (for an employee)\n",
"summary": "Delete a specific child record",
"operationId": "DeleteChildByChildId",
"parameters": [
{
"$ref": "#/components/parameters/childId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/occupationaldisabilities": {
"get": {
"tags": [
"Occupational disability"
],
"description": "__Activity name :__ GetOccupationalDisabilitiesByEmployeeId\n\nGet 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).\n",
"summary": "List of occupational disabilities for an employee",
"operationId": "GetOccupationalDisabilitiesByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/occupationalDisability"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/partners": {
"get": {
"tags": [
"Partner"
],
"description": "__Activity name :__ GetPartnersByEmployeeId\n\nGet the list of partners of the employee\n",
"summary": "List of partners for an employee",
"operationId": "GetPartnersByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/partner"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Partner"
],
"description": "__Activity name :__ PostPartnerByEmployeeId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL. \n\nCreate the partner for an employee\n",
"summary": "Create the partner for an employee",
"operationId": "PostPartnerByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Partner to add to the employee.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/partner"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/partner"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/partners/{partnerId}": {
"get": {
"tags": [
"Partner"
],
"description": "__Activity name :__ GetPartnerByPartnerId\n\nGet the details of a single partner\n",
"summary": "Details of a single partner",
"operationId": "GetPartnerByPartnerId",
"parameters": [
{
"$ref": "#/components/parameters/partnerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/partner"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Partner"
],
"description": "__Activity name :__ PutPartnerByPartnerId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n\nEdit the partner information\n",
"summary": "Edit the details for a partner",
"operationId": "PutPartnerByPartnerId",
"parameters": [
{
"$ref": "#/components/parameters/partnerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Partner to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/partner"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/partner"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Partner"
],
"description": "__Activity name :__ DeletePartnerByPartnerId\n\nDelete an existing partner\n",
"summary": "Delete a specific partner record",
"operationId": "DeletePartnerByPartnerId",
"parameters": [
{
"$ref": "#/components/parameters/partnerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/citizenservicenumber": {
"get": {
"tags": [
"Employee"
],
"description": "__Activity name :__ GetCitizenServiceNumberByEmployeeId\n\nGet the citizen service number of an employee. BSN is separately authorized in Loket and is therefore designed to have its own activities.\n",
"summary": "Citizen service number of an employee",
"operationId": "GetCitizenServiceNumberByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/citizenServiceNumber-2"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Employee"
],
"description": "__Activity name :__ PutCitizenServiceNumberByEmployeeId\n\nUpdate the citizen service number of an employee. BSN is separately authorized in Loket and is therefore designed to have its own activities.\n",
"summary": "Update the citizen service number of an employee",
"operationId": "PutCitizenServiceNumberByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "citizen service number to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/citizenServiceNumber"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/citizenServiceNumber"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/photo": {
"get": {
"tags": [
"Employee"
],
"description": "__Activity name :__ GetEmployeePhotoByEmployeeId\n\nPhoto of the employee to use as an avatar/profile picture\n\n__Caching:__ This resource changes very infrequently and can be cached for a longer time.\n",
"summary": "Photo of an employee",
"operationId": "GetEmployeePhotoByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/jpg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Employee"
],
"description": "__Activity name :__ PostEmployeePhotoByEmployeeId\n\nPhoto of the employee to use as an avatar/profile picture\n",
"summary": "Post employee photo",
"operationId": "PostEmployeePhotoByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Logo to be uploaded for the employer.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/logoPostObject"
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Employee"
],
"description": "__Activity name :__ DeleteEmployeePhotoByEmployeeId\n\nPhoto of the employee to use as an avatar/profile picture\n",
"summary": "Delete employee photo",
"operationId": "DeleteEmployeePhotoByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/photo/{version}": {
"get": {
"tags": [
"Employee"
],
"description": "__Activity name :__ GetEmployeePhotoByEmployeeIdAndVersion\n\nPhoto of the employee to use as an avatar/profile picture\n\n__Caching:__ This resource changes very infrequently and can be cached for a longer time.\n",
"summary": "Photo of an employee",
"operationId": "GetEmployeePhotoByEmployeeIdAndVersion",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/version"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/jpg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employee": {
"post": {
"tags": [
"Employee"
],
"description": "__Activity name :__ PostEmployeeByEmployerId\n\nThis endpoint 'creates' an employee in Loket with its corresponding entities. This means creating a number of records including Employee, Employment, WorkingHours, Wage etc.\n\nBefore doing performing these steps, quite a number of validations are performed to ensure that the provided information can be used to create a functionally valid employee.\n",
"summary": "Create a new employee in Loket",
"operationId": "PostEmployeeByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Employee to be created",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employee2024-11-13"
}
}
}
},
"responses": {
"201": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "object",
"properties": {
"employeeId": {
"$ref": "#/components/schemas/id"
},
"employmentId": {
"$ref": "#/components/schemas/id"
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/revokeEmployeeSelfServiceAccess": {
"patch": {
"tags": [
"Employee"
],
"description": "__Activity name :__ PatchRevokeEmployeeSelfServiceAccessByEmployeeId\n\nThis 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.\n\nThe 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.\n",
"summary": "Set the date on which to revoke ESS access",
"operationId": "PatchRevokeEmployeeSelfServiceAccessByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "The request body contains an object containing fields related to termination of an employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/revokeEmployeeSelfServiceAccess"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/customfields": {
"get": {
"tags": [
"Employee custom field"
],
"description": "__Activity name :__ GetEmployeeCustomFieldsByEmployeeId\n\nGet a list of the custom fields for an employee.\n\n__Note:__ custom fields are user defined at the employer level.\n",
"summary": "List employee custom fields for an employee",
"operationId": "GetEmployeeCustomFieldssByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employeeCustomField"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Employee custom field"
],
"description": "__Activity name :__ PostEmployeeCustomFieldByEmployeeId\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n",
"summary": "Add an employee custom field for an employee",
"operationId": "PostEmployeeCustomFieldByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a custom field",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employeeCustomFieldPost"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employeeCustomField"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/customfields/{employeeCustomFieldId}": {
"get": {
"tags": [
"Employee custom field"
],
"description": "__Activity name :__ GetEmployeeCustomFieldByEmployeeCustomFieldId\n\nGet the details of a custom field\n",
"summary": "Details of an employee custom field",
"operationId": "GetEmployeeCustomFieldByEmployeeCustomFieldId",
"parameters": [
{
"$ref": "#/components/parameters/employeeCustomFieldId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employeeCustomField"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Employee custom field"
],
"description": "__Activity name :__ PutEmployeeCustomFieldByEmployeeCustomFieldId\n\n__Metadata :__ No metadata available for this endpoint\n",
"summary": "Edit an employee custom field record",
"operationId": "PutEmployeeCustomFieldByEmployeeCustomFieldId",
"parameters": [
{
"$ref": "#/components/parameters/employeeCustomFieldId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employeeCustomField"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employeeCustomField"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Employee custom field"
],
"description": "__Activity name :__ DeleteEmployeeCustomFieldByEmployeeCustomFieldId\n\nDelete an existing custom field record\n",
"summary": "Delete an employee custom field record",
"operationId": "DeleteEmployeeCustomFieldByEmployeeCustomFieldId",
"parameters": [
{
"$ref": "#/components/parameters/employeeCustomFieldId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers": {
"get": {
"tags": [
"Employer"
],
"description": "__Activity name :__ GetEmployersByUserId\n\nGet a list of all employers accessible to the current user\n\nPlease note the following general remark regarding the Loket API. If an id is required as a path parameter, in almost all cases the UUID of the specific resource should be used. In the employer resource this corresponds to the the 'id' field, as is typical. (so do NOT use employerNumber as your path parameter for any following requests)\n",
"summary": "List of employers",
"operationId": "GetEmployersByUserId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employer"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/minimized": {
"get": {
"tags": [
"Employer"
],
"description": "__Activity name :__ GetEmployersMinimizedByUserId\n\nGet a list of all employers accessible to the current user. With this endpoint we introduced the \"Minimized\" resource which contains fewer fields then `/v2/providers/employers`. This version should increase performance when requesting employments for large employers.\n",
"summary": "List of employers with fewer fields for performance reasons",
"operationId": "GetEmployersMinimizedByUserId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2025-11-03": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employerMinimized"
}
}
}
}
]
}
},
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employerMinimized"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/employers": {
"post": {
"tags": [
"Employer"
],
"description": "__Activity name :__ PostEmployerByProviderId\n\nCreate an employee for the provider (administratiekantoor) identified by the given providerId.\nPlease take note of the following; a newly created Employer is not immediately accessible for the user.\nAs this would require adding the Employer to a specific Loket team (which is a separate activity). \nEven after adding the Employer to a team, it may take a few minutes before the Employer is accessible for the user because of caching.\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.",
"summary": "Create an employer",
"operationId": "PostEmployerByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Employer to be created.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employer"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employer"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/employers/minimized": {
"get": {
"tags": [
"Employer"
],
"description": "__Activity name :__ GetEmployersMinimizedByProviderId\n\nGet a list of all employers for the provider.\n",
"summary": "List of all employers for the provider",
"operationId": "GetEmployersMinimizedByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2025-11-03": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employerMinimized"
}
}
}
}
]
}
},
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employerMinimized"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/employers/informationForWizard": {
"get": {
"tags": [
"Employer"
],
"description": "__Activity name :__ GetInformationForAddEmployerWizardByProviderId\n\nGet information to determine which steps of the add employer wizard the loged in user can perform.\n",
"summary": "Determine which steps of the add employer wizard the user can perform",
"operationId": "GetInformationForAddEmployerWizardByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/informationForWizard"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}": {
"get": {
"tags": [
"Employer"
],
"description": "__Activity name :__ GetEmployerByEmployerId\n\nGet the details of a single employers\n",
"summary": "Details of an employer",
"operationId": "GetEmployerByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employer"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Employer"
],
"description": "__Activity name:__ PutEmployerByEmployerId\n\nEdit the details of an employer\n\nPossible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n",
"summary": "Edit the details of an employer",
"operationId": "PutEmployerByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Employer",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employer"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employer"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/childEmployers": {
"get": {
"tags": [
"Employer"
],
"description": "__Activity name :__ GetChildEmployersByEmployerId\n\nGet a list of all employers accessible to the current user which are a child of the provided employer. \n",
"summary": "List of child employers accessible to the current user",
"operationId": "GetChildEmployersByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/includeParent"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/childEmployer"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/functions": {
"get": {
"tags": [
"Functions"
],
"description": "__Activity name :__ GetFunctionsByEmployerId\n\nGet 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.\n",
"summary": "List of functions",
"operationId": "GetFunctionsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/function"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Functions"
],
"description": "__Activity name:__ PostFunctionByEmployerId
Create a function for an employer
__Metadata:__ No metadata
__Defaults:__ No default values
\n",
"summary": "Create a function for an employer",
"operationId": "PostFunctionByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Function to add to the employer.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/function"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/function"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/functions/{functionId}": {
"get": {
"tags": [
"Functions"
],
"description": "__Activity name:__ GetFunctionByFunctionId\n\nGet the details of function\n",
"summary": "Details of a function",
"operationId": "GetFunctionByFunctionId",
"parameters": [
{
"$ref": "#/components/parameters/functionId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/function"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Functions"
],
"description": "__Activity name:__ PutFunctionByFunctionId\n\nEdit the details for a function\n\n__Metadata:__ No metadata\n",
"summary": "Edit the details of a function",
"operationId": "PutFunctionByFunctionId",
"parameters": [
{
"$ref": "#/components/parameters/functionId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Function to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/function"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/function"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/departments": {
"get": {
"tags": [
"Departments"
],
"description": "__Activity name :__ GetDepartmentsByEmployerId\n\nGet 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.\n",
"summary": "List of departments",
"operationId": "GetDepartmentsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/departmentGetPostObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Departments"
],
"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
\n",
"summary": "Create a department for an employer",
"operationId": "PostDepartmentByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Department to add to the employer.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/departmentGetPostObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/departmentGetPostObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/departments/{departmentId}": {
"get": {
"tags": [
"Departments"
],
"description": "__Activity name:__ GetDepartmentByDepartmentId\n\nGet the details of department\n",
"summary": "Details of a department",
"operationId": "GetDepartmentByDepartmentId",
"parameters": [
{
"$ref": "#/components/parameters/departmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/departmentGetPostObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Departments"
],
"description": "__Activity name:__ PutDepartmentByDepartmentId\n\nEdit the details for a department\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n",
"summary": "Edit the details of a department",
"operationId": "PutDepartmentByDepartmentId",
"parameters": [
{
"$ref": "#/components/parameters/departmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Department to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/departmentPutObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/departmentGetPostObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/useraccessibledepartments": {
"get": {
"tags": [
"Departments"
],
"description": "__Activity name :__ GetUserAccessibleDepartmentsByEmployerId\n\nGet a list of all departments for the employer, which are accesible for the current user. \n",
"summary": "List of user accessible departments",
"operationId": "GetUserAccessibleDepartmentsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/departmentGetPostObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/logo": {
"get": {
"tags": [
"Employer"
],
"description": "__Activity name :__ GetEmployerLogoByEmployerId\n\nThis activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.\n\n__Caching:__ This resource changes very infrequently and can be cached for a longer period.\n\nGet the logo of the employer. In case no logo is know the service will return a 404.\n",
"summary": "Logo of an employer",
"operationId": "GetEmployerLogoByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/jpg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Employer"
],
"description": "__Activity name:__ DeleteEmployerLogoByEmployerId\n\nDelete the logo of an employer\n",
"summary": "Delete the employer logo",
"operationId": "DeleteEmployerLogoByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Employer"
],
"description": "__Activity name :__ PostEmployerLogoByEmployerId\n\nUpload a logo for the employer.\n",
"summary": "Upload a logo for the employer",
"operationId": "PostEmployerLogoByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Logo to be uploaded for the employer.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/logoPostObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/messageWarning-2"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/logo/{version}": {
"get": {
"tags": [
"Employer"
],
"description": "__Activity name :__ GetEmployerLogoByEmployerId\n\nThis activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.\n\n__Caching:__ This resource changes very infrequently and can be cached for a longer period.\n\nGet the logo of the employer. In case no logo is know the service will return a 404.\n",
"summary": "Logo of an employer",
"operationId": "GetEmployerLogoByEmployerIdAndVersion",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"in": "path",
"name": "version",
"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.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/jpg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/providerlogo": {
"get": {
"tags": [
"Employer"
],
"description": "__Activity name :__ GetProviderLogoByEmployerId\n\nThis activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.\n\nGet the (deviating) provider logo of the employers. In case no logo is know the service will return a 404.\n\n__Caching:__ This resource changes very infrequently and can be cached for a longer time.",
"summary": "Provider logo",
"operationId": "GetProviderLogoByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary",
"description": "A binary string representation of the image."
}
},
"image/jpg": {
"schema": {
"type": "string",
"format": "binary",
"description": "A binary string representation of the image."
}
},
"image/png": {
"schema": {
"type": "string",
"format": "binary",
"description": "A binary string representation of the image."
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/providerlogo/{version}": {
"get": {
"tags": [
"Employer"
],
"description": "__Activity name :__ GetProviderLogoByEmployerId\n\nThis activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.\n\nGet the (deviating) provider logo of the employers. In case no logo is know the service will return a 404.\n\n__Caching:__ This resource changes very infrequently and can be cached for a longer time.",
"summary": "Provider logo",
"operationId": "GetProviderLogoByEmployerIdAndVersion",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"in": "path",
"name": "version",
"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.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary",
"description": "A binary string representation of the image."
}
},
"image/jpg": {
"schema": {
"type": "string",
"format": "binary",
"description": "A binary string representation of the image."
}
},
"image/png": {
"schema": {
"type": "string",
"format": "binary",
"description": "A binary string representation of the image."
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/dashboard": {
"get": {
"tags": [
"Employer dashboard"
],
"description": "__Activity name :__ GetEmployerDashboardByEmployerId\n\nGet the url for the Qlik dashboard for this employer.\nPlease note: the Qlik dashboard is only accessible for users with an assigned Qlik dashboard licenses.\n",
"summary": "Dashboard of an employer",
"operationId": "GetEmployerDashboardByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/dashboard"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/customfields": {
"get": {
"tags": [
"Custom field"
],
"description": "__Activity name :__ GetCustomFieldsByEmployerId\n\nGet a list of the custom fields for an employer.\n\n__Note:__ The custom fields defined at the employer level can be used at the employee and employment level.\n",
"summary": "List custom fields for an employer",
"operationId": "GetCustomFieldsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customField"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Custom field"
],
"description": "__Activity name :__ PostCustomFieldByEmployerId\n",
"summary": "Add a custom field for an employer",
"operationId": "PostCustomFieldByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a custom field",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/customField"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/customField"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/customfields/{customFieldId}": {
"get": {
"tags": [
"Custom field"
],
"description": "__Activity name :__ GetCustomFieldByCustomFieldId\n\nGet the details of a custom field\n",
"summary": "Details of a custom field",
"operationId": "GetCustomFieldByCustomFieldId",
"parameters": [
{
"$ref": "#/components/parameters/customFieldId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customField"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Custom field"
],
"description": "__Activity name :__ PutCustomFieldByCustomFieldId\n",
"summary": "Edit a custom field record",
"operationId": "PutCustomFieldByCustomFieldId",
"parameters": [
{
"$ref": "#/components/parameters/customFieldId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/customField"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/customField"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Custom field"
],
"description": "__Activity name :__ DeleteCustomFieldByCustomFieldId\n\nDelete an existing custom field record\n",
"summary": "Delete a custom field record",
"operationId": "DeleteCustomFieldByCustomFieldId",
"parameters": [
{
"$ref": "#/components/parameters/customFieldId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/educationtypes": {
"get": {
"tags": [
"Education type"
],
"description": "__Activity name :__ GetEducationTypesByEmployerId\n\nGet a list of the education types for an employer.\n\n__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.\n",
"summary": "List education types for an employer",
"operationId": "GetEducationTypesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/educationType"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Education type"
],
"description": "__Activity name :__ PostEducationTypeByEmployerId\n",
"summary": "Add an education type for an employer",
"operationId": "PostEducationTypeByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add an education type",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/educationType"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/educationType"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/educationtypes/{educationTypeId}": {
"get": {
"tags": [
"Education type"
],
"description": "__Activity name :__ GetEducationTypeByEducationTypeId\n\nGet the details of an education type\n",
"summary": "Details of an education type",
"operationId": "GetEducationTypeByEducationTypeId",
"parameters": [
{
"$ref": "#/components/parameters/educationTypeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/educationType"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Education type"
],
"description": "__Activity name :__ PutEducationTypeByEducationTypeId\n",
"summary": "Edit an education type record",
"operationId": "PutEducationTypeByEducationTypeId",
"parameters": [
{
"$ref": "#/components/parameters/educationTypeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/educationType"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/educationType"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Education type"
],
"description": "__Activity name :__ DeleteEducationTypeByEducationTypeId\n\nDelete an existing education type record\n",
"summary": "Delete an education type record",
"operationId": "DeleteEducationTypeByEducationTypeId",
"parameters": [
{
"$ref": "#/components/parameters/educationTypeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/educationfurtherindications": {
"get": {
"tags": [
"Education further indication"
],
"description": "__Activity name :__ GetEducationFurtherIndicationsByEmployerId\n\nGet a list of the education further indications for an employer.\n\n__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.\n",
"summary": "List education further indications for an employer",
"operationId": "GetEducationFurtherIndicationsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/educationFurtherIndication"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Education further indication"
],
"description": "__Activity name :__ PostEducationFurtherIndicationByEmployerId\n",
"summary": "Add an education further indication for an employer",
"operationId": "PostEducationFurtherIndicationByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add an education further indication",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/educationFurtherIndication"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/educationFurtherIndication"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/educationfurtherindications/{educationFurtherIndicationId}": {
"get": {
"tags": [
"Education further indication"
],
"description": "__Activity name :__ GetEducationFurtherIndicationByEducationFurtherIndicationId\n\nGet the details of an education further indication\n",
"summary": "Details of an education further indication",
"operationId": "GetEducationFurtherIndicationByEducationFurtherIndicationId",
"parameters": [
{
"$ref": "#/components/parameters/educationFurtherIndicationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/educationFurtherIndication"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Education further indication"
],
"description": "__Activity name :__ PutEducationFurtherIndicationByEducationFurtherIndicationId\n",
"summary": "Edit an education further indication record",
"operationId": "PutEducationFurtherIndicationByEducationFurtherIndicationId",
"parameters": [
{
"$ref": "#/components/parameters/educationFurtherIndicationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/educationFurtherIndication"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/educationFurtherIndication"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Education further indication"
],
"description": "__Activity name :__ DeleteEducationFurtherIndicationByEducationFurtherIndicationId\n\nDelete an existing education further indication record\n",
"summary": "Delete an education further indication record",
"operationId": "DeleteEducationFurtherIndicationByEducationFurtherIndicationId",
"parameters": [
{
"$ref": "#/components/parameters/educationFurtherIndicationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/contractcodes": {
"get": {
"tags": [
"Contract code"
],
"description": "__Activity name :__ GetContractCodesByEmployerId\n\n\nGet a list of the contract codes for an employer.\n\n__Note:__ The contract codes defined at the employer level can be used as value for the field contractCode in the WorkingHours and ConceptEmployee resource.\n",
"summary": "List contract codes for an employer",
"operationId": "GetContractCodesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/contractCode"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Contract code"
],
"description": "__Activity name :__ PostContractCodeByEmployerId\n",
"summary": "Add a contract code for an employer",
"operationId": "PostContractCodeByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a contract code",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/contractCode"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/contractCode"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/contractcodes/{contractCodeId}": {
"get": {
"tags": [
"Contract code"
],
"description": "__Activity name :__ GetContractCodeByContractCodeId\n\n\nGet the details of a contract code\n",
"summary": "Details of a contract code",
"operationId": "GetContractCodeByContractCodeId",
"parameters": [
{
"$ref": "#/components/parameters/contractCodeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/contractCode"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Contract code"
],
"description": "__Activity name :__ PutContractCodeByContractCodeId\n",
"summary": "Edit a contract code record",
"operationId": "PutContractCodeByContractCodeId",
"parameters": [
{
"$ref": "#/components/parameters/contractCodeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/contractCode"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/contractCode"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Contract code"
],
"description": "__Activity name :__ DeleteContractCodeByContractCodeId\n\n\nDelete an existing contract code record\n",
"summary": "Delete a contract code record",
"operationId": "DeleteContractCodeByContractCodeId",
"parameters": [
{
"$ref": "#/components/parameters/contractCodeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/benefitinkindtypes": {
"get": {
"tags": [
"Benefit in kind type"
],
"description": "__Activity name :__ GetBenefitInKindTypesByEmployerId\n\nGet a list of the benefit in kind types for an employer.\n\n__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.\n",
"summary": "List benefit in kind types for an employer",
"operationId": "GetBenefitInKindTypesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/benefitInKindType"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Benefit in kind type"
],
"description": "__Activity name :__ PostBenefitInKindTypeByEmployerId\n",
"summary": "Add an benefit in kind type for an employer",
"operationId": "PostBenefitInKindTypeByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add an benefit in kind type",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/benefitInKindType"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/benefitInKindType"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/benefitinkindtypes/{benefitInKindTypeId}": {
"get": {
"tags": [
"Benefit in kind type"
],
"description": "__Activity name :__ GetBenefitInKindTypeByBenefitInKindTypeId\n\nGet the details of an benefit in kind type\n",
"summary": "Details of an benefit in kind type",
"operationId": "GetBenefitInKindTypeByBenefitInKindTypeId",
"parameters": [
{
"$ref": "#/components/parameters/benefitInKindTypeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/benefitInKindType"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Benefit in kind type"
],
"description": "__Activity name :__ PutBenefitInKindTypeByBenefitInKindTypeId\n",
"summary": "Edit an benefit in kind type record",
"operationId": "PutBenefitInKindTypeByBenefitInKindTypeId",
"parameters": [
{
"$ref": "#/components/parameters/benefitInKindTypeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/benefitInKindType"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/benefitInKindType"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Benefit in kind type"
],
"description": "__Activity name :__ DeleteBenefitInKindTypeByBenefitInKindTypeId\n\nDelete an existing benefit in kind type record\n",
"summary": "Delete an benefit in kind type record",
"operationId": "DeleteBenefitInKindTypeByBenefitInKindTypeId",
"parameters": [
{
"$ref": "#/components/parameters/benefitInKindTypeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/customholidays": {
"get": {
"tags": [
"Custom holiday"
],
"description": "__Activity name :__ GetCustomHolidaysByEmployerId\n\nGet a list of the custom holidays for an employer.\n\n__Note:__ The custom holidays defined at the employer level can be used at the employee and employment level.\n",
"summary": "List custom holidays for an employer",
"operationId": "GetCustomHolidaysByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customHoliday"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Custom holiday"
],
"description": "__Activity name :__ PostCustomHolidayByEmployerId\n",
"summary": "Add a custom holiday for an employer",
"operationId": "PostCustomHolidayByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a custom holiday",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/customHoliday"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/customHoliday"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/customholidays/{customHolidayId}": {
"get": {
"tags": [
"Custom holiday"
],
"description": "__Activity name :__ GetCustomHolidayByCustomHolidayId\n\nGet the details of a custom holiday\n",
"summary": "Details of a custom holiday",
"operationId": "GetCustomHolidayByCustomHolidayId",
"parameters": [
{
"$ref": "#/components/parameters/customHolidayId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customHoliday"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Custom holiday"
],
"description": "__Activity name :__ PutCustomHolidayByCustomHolidayId\n",
"summary": "Edit a custom holiday record",
"operationId": "PutCustomHolidayByCustomHolidayId",
"parameters": [
{
"$ref": "#/components/parameters/customHolidayId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/customHoliday"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/customHoliday"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Custom holiday"
],
"description": "__Activity name :__ DeleteCustomHolidayByCustomHolidayId\n\nDelete an existing custom holiday record\n",
"summary": "Delete a custom holiday record",
"operationId": "DeleteCustomHolidayByCustomHolidayId",
"parameters": [
{
"$ref": "#/components/parameters/customHolidayId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/billing/providers/employers/{employerId}/billableitems": {
"get": {
"tags": [
"Billable item"
],
"description": "__Activity name :__ GetBillableItemsByEmployerId\n\nGet a list of all billable items for the employer. \n",
"summary": "List of billable items for an employer",
"operationId": "GetBillableItemsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/billableItemEmployerObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/nationalholidays": {
"get": {
"tags": [
"National holiday"
],
"description": "__Activity name :__ GetNationalHolidaysByEmployerId\n\nGet a list of all national holidays for the employer\n",
"summary": "List of national holidays",
"operationId": "GetNationalHolidaysByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nationalHoliday"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/nationalholidays/{nationalHolidayId}": {
"get": {
"tags": [
"National holiday"
],
"description": "__Activity name:__ GetNationalHolidaysByEmployerIdAndNationalHolidayId\n\nGet the details of a national holiday\n",
"summary": "Details of a national holiday",
"operationId": "GetNationalHolidaysByEmployerIdAndNationalHolidayId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/nationalHolidayId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/nationalHoliday"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"National holiday"
],
"description": "__Activity name:__ PutNationalHolidayByEmployerIdAndNationalHolidayId\n\nEdit the details for a national holiday\n\n__Metadata :__ There is no metadata endpoint for this resource.\n",
"summary": "Edit the details of a national holidays",
"operationId": "PutNationalHolidayByEmployerIdAndNationalHolidayId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/nationalHolidayId"
}
],
"requestBody": {
"description": "National holiday to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/nationalHoliday"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/nationalHoliday"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/configuration": {
"get": {
"tags": [
"Employer configuration"
],
"description": "__Activity name :__ GetEmployerConfigurationByEmployerId \n\nGet the configuration at Employer level. This configuration is managed by the provider.\n",
"summary": "Employer configuration",
"operationId": "GetEmployerConfigurationByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/configurationObject"
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Employer configuration"
],
"description": "__Activity name :__ PutEmployerConfigurationByEmployerId\n\nEdit the configuration at Employer level. This configuration is managed by the provider.\n",
"summary": "Edit Employer configuration",
"operationId": "PutEmployerConfigurationByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/configurationObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/configurationObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/distributionunits": {
"get": {
"tags": [
"Distribution Units"
],
"description": "__Activity name :__ GetDistributionUnitsByEmployerId\n\nGet a list of all distribution units for the employer. \n",
"summary": "List of distribution units",
"operationId": "GetDistributionUnitsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/distributionUnitGetPostObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Distribution Units"
],
"description": "__Activity name:__ PostDistributionUnitByEmployerId
Create a distribution unit for an employer
__Metadata :__ No metadata available.
__Defaults:__ No default values
\n",
"summary": "Create a distribution unit for an employer",
"operationId": "PostDistributionUnitByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Distribution unit to add to the employer.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/distributionUnitGetPostObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/distributionUnitGetPostObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/distributionunits/{distributionUnitId}": {
"get": {
"tags": [
"Distribution Units"
],
"description": "__Activity name:__ GetDistributionUnitByDistributionUnitId\n\nGet the details of a distribution unit\n",
"summary": "Details of a distribution unit",
"operationId": "GetDistributionUnitByDistributionUnitId",
"parameters": [
{
"$ref": "#/components/parameters/distributionUnitId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/distributionUnitGetPostObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Distribution Units"
],
"description": "__Activity name:__ PutDistributionUnitByDistributionUnitId\n\nEdit the details for a distribution unit\n\n__Metadata :__ No metadata available.\n",
"summary": "Edit the details of a distribution unit",
"operationId": "PutDistributionUnitByDistributionUnitId",
"parameters": [
{
"$ref": "#/components/parameters/distributionUnitId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "distribution unit to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/distributionUnitPutObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/distributionUnitGetPostObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/year/providers/employers/payrolladministrations/{payrollAdministrationId}/years/{yearId}/requestyeartransition": {
"patch": {
"tags": [
"Year transition"
],
"description": "__Activity name :__ PatchRequestYearTransitionByPayrollAdministrationIdAndYearId\n\nThis endpoint allows the user to request a year transition for a specific payroll administration and year. \nThe user can indicate if an email will be sent to the employees and the date on which the employee can access the yearendstatement.\nDuring the year transition the given year will be closed and a new year will be opened.\n",
"summary": "Request year transition",
"operationId": "PatchRequestYearTransitionByPayrollAdministrationIdAndYearId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/yearId"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/yearTransitionPatch"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/year/providers/employers/payrolladministrations/years/{yearId}/undorequestyeartransition": {
"patch": {
"tags": [
"Year transition"
],
"description": "__Activity name :__ PatchUndoRequestYearTransitionByPayrollAdministrationYearId \nThis endpoint enables the user to revoke a request for year transition for a specific payroll administration and year.\nRevoking a year transition is only possible if the year transition has not yet been processed.\nBoth the input and output are empty objects.\n",
"summary": "Undo request year transition",
"operationId": "PatchUndoRequestYearTransitionByPayrollAdministrationYearId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/yearId"
}
],
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/year/providers/employers/payrolladministrations/years/{yearId}/requestyeartransition": {
"post": {
"tags": [
"Year transition"
],
"description": "__Activity name :__ PostRequestYearTransitionCollectiveByBearerTokenAndYearId\n\nThis endpoint allows the user to request a year transition for several payroll administrations. \nThe user can indicate if an email will be sent to the employees and the date on which the employee can access the yearendstatement.\nDuring the year transition the given year will be closed and a new year will be opened.\n",
"summary": "Request year transition collective",
"operationId": "PostRequestYearTransitionCollectiveByBearerTokenAndYearId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/yearId"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/yearTransitionCollective"
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/conceptemployees/selfservice": {
"get": {
"tags": [
"Concept employee self service"
],
"description": "__Activity name :__ GetConceptEmployeeSelfServiceByEmployerId\n\nGet a list of all the Concept employee's and their status regarding to ESS (werknemer.loket).\n",
"summary": "List of Concept employee's and their ESS (WNL) status",
"operationId": "GetConceptEmployeeSelfServiceByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/essAccessConceptEmployee"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/selfservice": {
"get": {
"tags": [
"Concept employee self service"
],
"description": "__Activity name :__ GetConceptEmployeeSelfServiceByConceptEmployeeId\n\nGet the details of a Concept employee with regards to ESS access\n",
"summary": "Details of a Concept employee self service portal status",
"operationId": "GetConceptEmployeeSelfServiceByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/essAccessConceptEmployee"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/selfservice": {
"get": {
"tags": [
"Employee self service"
],
"description": "__Activity name :__ GetEmployeeSelfServiceByEmployerId\n\nGet a list of all the employee's and their status regarding to ESS (werknemer.loket).\n",
"summary": "List of employee's and their ESS (WNL) status",
"operationId": "GetEmployeeSelfServiceByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/essAccess"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Employee self service"
],
"description": "__Activity name :__ PatchEmployeeSelfServiceAccessByEmployerId\n\nThis endpoint allows the user to change the status of access to ESS for several employees of the employer.\n",
"summary": "Change the ESS access for several employees",
"operationId": "PatchEmployeeSelfServiceAccessByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employeeSelfServicePatch"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/selfservice": {
"get": {
"tags": [
"Employee self service"
],
"description": "__Activity name :__ GetEmployeeSelfServiceByEmployeeId\n\nGet the details of an employee with regards to ESS access\n",
"summary": "Details of and employees self service portal status",
"operationId": "GetEmployeeSelfServiceByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/essAccess"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/selfservice": {
"patch": {
"tags": [
"Employee self service"
],
"description": "__Activity name :__ PatchEmployeeSelfServiceAccessByEmployeeId\n\nThis endpoint allows the user to change the status of access for the employee's to ESS (Werknemer.loket).\n",
"summary": "Change the employee's self service (ESS) access",
"operationId": "PatchEmployeeSelfServiceAccessByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employeeSelfServicePatch"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/selfservice/migration": {
"get": {
"tags": [
"Employee self service"
],
"description": "__Activity name :__ GetSelfServiceEmployeesToBeMigratedByEmployerId\n\nGet all employees with ESS (WNL) access and NO MijnLoket connection with employer OR pending invite to connect with employer in MijnLoket\n",
"summary": "List of all employees with ESS access (to be migrated to MijnLoket)",
"operationId": "GetSelfServiceEmployeesToBeMigratedByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/essAccessMigration"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/person/account/person/employees/{employeeId}/information": {
"get": {
"tags": [
"Employee self service"
],
"description": "__Activity name :__ GetConnectedUserInformationByEmployeeId\n\nGet the username and emailAddress of the employee used to create the account for self service application\n",
"summary": "username and emailAddress of the connected account",
"operationId": "GetConnectedUserInformationByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userInformation"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/essaccessstatus": {
"get": {
"tags": [
"Employee self service"
],
"description": "__Activity name :__ GetESSAccessStatusByEmployerId\n\nGet a list of all the employee's and their status regarding to the ESS application.\n",
"summary": "List of employee's ESS access status",
"operationId": "GetESSAccessStatusByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/essAccessClever"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Employee self service"
],
"description": "__Activity name :__ PatchESSAccessStatusByEmployerId\n\nThis endpoint allows the user to change the status of access to the ESS for several employees of the employer.\n",
"summary": "Change the ESS access for several employees",
"operationId": "PatchESSAccessStatusByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employeeSelfServicePatchClever"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/ess/wageprojection": {
"post": {
"tags": [
"Employee self service wage projection"
],
"description": "__Activity name :__ PostEssWageProjectionByEmploymentId\n\nThis endpoint performs an employee self service wage projection for an existing employment.",
"summary": "Perform an employee self service wage projection",
"operationId": "PostEssWageProjectionByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollPeriodResultComparison"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/ess/wageprojection/customise": {
"post": {
"tags": [
"Employee self service wage projection"
],
"description": "__Activity name :__ PostEssWageProjectionCustomiseByEmploymentId\n\nThis endpoint customises an employee self service wage projection for an existing employment.",
"summary": "Customise an employee self service wage projection",
"operationId": "PostEssWageProjectionCustomiseByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "object",
"$ref": "#/components/schemas/wageProjectionCustomiseInput"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/wageProjectionComparisonResult"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/ess/wageprojection/collectivelaboragreement": {
"post": {
"tags": [
"Employee self service wage projection"
],
"description": "__Activity name :__ PostEssWageProjectionBasedOnDefaultClaConfigurationByBearerToken\n\nThis endpoint performs an employee self service wage projection based on default CLA configuration using the bearer token context.",
"summary": "Perform an employee self service wage projection based on default CLA configuration",
"operationId": "PostEssWageProjectionBasedOnDefaultClaConfigurationByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "object",
"$ref": "#/components/schemas/wageProjectionByCollectiveLaborAgreementInput"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/wageProjectionComparisonResult"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/authorizations": {
"get": {
"tags": [
"Authorizations"
],
"description": "__Activity name :__ GetAuthorizationsByEmployerId\n\nGet the array of activities the user is authenticated for with regard to the specified employer\n",
"summary": "List of authorized activities with regard to the employer",
"operationId": "GetAuthorizationsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2019-02-11": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "GetJournalRunsByPayrollAdministrationId",
"readOnly": true
}
}
}
}
}
}
]
}
},
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/authorizations": {
"get": {
"tags": [
"Authorizations"
],
"description": "__Activity name :__ GetAuthorizationsByProviderId\n\n\n\n\nGet the array of activities the user is authenticated for with regard to the specified provider. This endpoint is only accessible for providerusers.\n",
"summary": "List of authorized activities with regard to the provider",
"operationId": "GetAuthorizationsByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "GetJournalRunsByPayrollAdministrationId",
"readOnly": true
}
}
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/modules": {
"get": {
"tags": [
"Modules"
],
"description": "__Activity name :__ GetModulesByEmployerId\n\nGet 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.\n",
"summary": "List of modules enabled for the employer",
"operationId": "GetModulesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/modules"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Modules"
],
"description": "__Activity name:__ PatchModulesByEmployerId\n\n__Metadata :__ Possible options can be acquired with the GetModulesByProviderId endpoint.\n\nThis endpoint enables the user to enable or disable several modules for an employer with one call.\n",
"summary": "Enable or disable modules for an employer",
"operationId": "PatchModulesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "The request body contains an array of modules to be enabled or disabled",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/modulesPatch"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/modules": {
"get": {
"tags": [
"Modules"
],
"description": "__Activity name :__ GetModulesByProviderId\n\nGet the array of the modules enabled for the employers of the specified provider. A module enables a certain functionality for the employer. These are typically called 'producten' in Loket.\n",
"summary": "List of modules enabled for the provider",
"operationId": "GetModulesByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/modules"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/conceptemployees": {
"get": {
"tags": [
"Concept employee"
],
"description": "__Activity name :__ GetConceptEmployeesByEmployerId\n\nGet 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.
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 to employee/employment. \n",
"summary": "List of concept employee for an employer",
"operationId": "GetConceptEmployeesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/conceptEmployee2018-01-01"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Concept employee"
],
"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 `../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}`.
* Possible options for payGrade can be acquired via `../v2/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 `../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}/paygrade/{payGradeKey}`. This endpoint has the optional parameter \\\"date\\\" that may be used to specifying a measure date.
__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 `/v2/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.
\"\n",
"summary": "Create a concept employee for an employer",
"operationId": "PostConceptEmployeeByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "concept employee to create to the employer.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/conceptEmployee2018-01-01"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/conceptEmployee2018-01-01"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/minimized/{conceptEmployeeId}": {
"get": {
"tags": [
"Concept employee"
],
"description": "__Activity name :__ GetConceptEmployeeMinimizedByConceptEmployeeId\n\n\n Get the details of a concept employee with fewer fields\n",
"summary": "Details of a concept employee with fewer fields.",
"operationId": "GetConceptEmployeeMinimizedByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/conceptEmployeeMinimized"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Concept employee"
],
"description": "__Activity name :__ PutConceptEmployeeMinimizedByConceptEmployeeId\n\nEdit the details of a concept employee with fewer fields.\n\n* Possible options (metadata) for generic fields of the type \"metadata\" can be acquired (GET) by adding `/metadata` to the URL.\n",
"summary": "Edit the details of a concept employee with fewer fields.",
"operationId": "PutConceptEmployeeMinizedByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Concept employee to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/conceptEmployeeMinimized"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/conceptEmployeeMinimized"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}": {
"get": {
"tags": [
"Concept employee"
],
"description": "__Activity name :__ GetConceptEmployeeByConceptEmployeeId\n\n\n Get the details of a concept employee\n",
"summary": "Details of a concept employee",
"operationId": "GetConceptEmployeeByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/conceptEmployee2018-01-01"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Concept employee"
],
"description": "__Activity name :__ PutConceptEmployeeByConceptEmployeeId\n\nEdit the details of a concept employee\n\n* Possible options (metadata) for generic fields of the type \"metadata\" can be acquired (GET) by adding `/metadata` to the URL.\n* Possible options dependent on a specific payrollAdministration can be acquired via `../v2/providers/employers/conceptemployees/metadata/payrollAdministration/{payrollAdministrationId}`.\n* Possible options for payGrade can be acquired via `../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}`.\n\nA `payGrade` has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request `../v2/providers/employers/conceptemployees/metadata/payscale/{payScaleKey}/paygrade/{payGradeKey}`.\n\n\n__NonPayrollAdministrations__ For nonPayrollAdministrations the equivalent MetaData-endpoints are also available as described above. However NO specific defaults endpoint is available for the nonPayrollAdministration.\n",
"summary": "Edit the details of a concept employee",
"operationId": "PutConceptEmployeeByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Concept employee to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/conceptEmployee2018-01-01"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/conceptEmployee2018-01-01"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Concept employee"
],
"description": "__Activity name :__ DeleteConceptEmployeeByConceptEmployeeId\n\nDelete a concept employee\n",
"summary": "Delete a concept employee",
"operationId": "DeleteConceptEmployeeByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/deleteDocuments"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/citizenservicenumber": {
"get": {
"tags": [
"Concept employee"
],
"description": "__Activity name :__ GetCitizenServiceNumberByConceptEmployeeId\n\nGet the citizen service number (BSN) of a concept employee. BSN is separately authorized in Loket and is therefore designed to have its own activities. \n",
"summary": "Citizen service number of a concept employee",
"operationId": "GetCitizenServiceNumberByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/citizenServiceNumber"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Concept employee"
],
"description": "__Activity name :__ PutCitizenServiceNumberByConceptEmployeeId\n\nUpdate the citizen service number (BSN) of a concept employee BSN is separately authorized in Loket and is therefore designed to have its own activities.\n",
"summary": "Update the citizen service number of a concept employee",
"operationId": "PutCitizenServiceNumberByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "citizen service number to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/citizenServiceNumber"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/citizenServiceNumber"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/convertToEmployee": {
"patch": {
"tags": [
"Concept employee"
],
"description": "__Activity name :__ PatchConvertToEmployeeByConceptEmployeeId\n\nThis endpoint \"converts\" the conceptEmployee to an actual employee in Loket. This means creating a number of records including Employee, Employment, WorkingHours, Wage etc. If the promotion is successful the concept employee record will be deleted.\n\nThe GUID of the conceptEmployee will be copied over to the GUID of the newly created Employee.\n\nBefore performing these steps, quite a number of validations are performed to ensure that the provided information can be used to create a functionally valid employee.\n\n\nIf the employeeNumber is empty then this will be set automatically for the employee. (i.e. highest available number +1)\n\n__Additional functionality :__\n* It is possible to call an alternative functionality closely related to this functionality. This additional functionality will perform the validation ONLY, and it will NOT convert the conceptEmployee to an actual employee even when all validation rules are successful. Other than not performing the actual step of converting the employee the endpoint will behave identically to the actual endpoint.\n* This functionality can be applied by setting the optional X-ValidateOnly header to true\n",
"summary": "Convert a concept employee to an employee",
"operationId": "PatchConvertToEmployeeByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/X-ValidateOnly"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/workflow/InitiateNewHireChecklist": {
"post": {
"tags": [
"Concept employee"
],
"description": "__Activity name :__ PostInitiateNewHireChecklistWorkflowByConceptEmployeeId\n\nAllows the user to trigger a workflow to start a checklist for a new employee.\n",
"summary": "Initiate the new hire checklist workflow for a concept employee",
"operationId": "PostInitiateNewHireChecklistWorkflowByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Input for the workflow",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/initiateNewHireChecklist"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/workflow/InitiateNewHireChecklist/information": {
"get": {
"tags": [
"Concept employee"
],
"description": "__Activity name :__ GetInformationForInitiateNewHireChecklistWorkflowByConceptEmployeeId\n\nGet information to determine whether an active new hire checklist workflow exists for the concept employee.\n",
"summary": "Information for initiating the new hire checklist workflow for a concept employee",
"operationId": "GetInformationForInitiateNewHireChecklistWorkflowByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/conceptEmployeeActiveWorkflow"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/metadata/payrollAdministration/{payrollAdministrationId}/payScale/{payscaleKey}/paygrade/{paygradeKey}": {
"get": {
"tags": [
"Paygrade"
],
"description": "__Activity name :__ GetConceptEmployeePayGradeMetaDataByPayrollAdministrationIdAndPayscaleKeyAndPayGradeKey\n\nAcquire data on a specific paygrade, this consists of a list of paygrade values and their respective startDates.\n\nIf a valid `date` parameter is included in the call, the list will consists of one item that is applicable for that date.\n",
"summary": "Paygrade metadata for concept employee",
"operationId": "GetConceptEmployeePayGradeMetaDataByPayrollAdministrationIdAndPayscaleKeyAndPayGradeKey",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payscaleKey"
},
{
"$ref": "#/components/parameters/paygradeKey"
},
{
"$ref": "#/components/parameters/date-2"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payGrade"
}
}
}
}
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/preboardingtrajectory": {
"get": {
"tags": [
"Preboarding trajectory"
],
"description": "__Activity name :__ GetPreboardingTrajectoryByConceptEmployeeId\n",
"summary": "Get the preboarding trajectory of a concept employee",
"operationId": "GetPreboardingTrajectoryByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/PreboardingTrajectory"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Preboarding trajectory"
],
"description": "__Activity name :__ PatchPreboardingTrajectoryByConceptEmployeeId\n",
"summary": "Change status of a preboarding trajectory",
"operationId": "PatchPreboardingTrajectoryByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "New status",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/PatchPreboardingTrajectory"
}
}
}
},
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Preboarding trajectory"
],
"description": "__Activity name :__ PostPreboardingTrajectoryByConceptEmployeeId\n",
"summary": "Add a preboarding trajectory",
"operationId": "PostPreboardingTrajectoryByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "None",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/PostPreboardingTrajectory"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/PreboardingTrajectory"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/employees/employments/actualpaygradeamounts": {
"get": {
"tags": [
"Paygrade"
],
"description": "__Activity name :__ GetActualPayGradeAmountsByPayrollAdministrationId\n\nProvides the PayGradeAmounts on a specific date for all PayScales of the payrolladministration's employments. This information can be used to create new wage records.\n",
"summary": "PayGradeAmounts for the employments",
"operationId": "GetActualPayGradeAmountsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payGradeAmounts"
}
}
}
}
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/assessment/initiate": {
"post": {
"tags": [
"Assessment"
],
"description": "__Activity name :__ PostInitiateAssessmentByConceptEmployeeId\n\n__Metadata:__ No metadata available. No defaults available.\n\n\nInitiate the proces to perform an assessment for a concept employee.\n",
"summary": "Initiate assessment",
"operationId": "PostInitiateAssessmentByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Contactinformation of the assessment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/assessmentPost"
}
}
}
},
"responses": {
"202": {
"description": "Initiated"
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/assessments": {
"get": {
"tags": [
"Assessment"
],
"description": "__Activity name :__ GetAssessmentsByEmployerId\n\n\nRetrieve a list of assessments.\n",
"summary": "List of assessments",
"operationId": "GetAssessmentsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/assessments"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/contactpersons": {
"get": {
"tags": [
"Concept employee contact person"
],
"description": "__Activity name :__ GetContactPersonsByConceptEmployeeId\n\nGet list of contact persons for a concept employee\n",
"summary": "List of contact persons for a concept employee",
"operationId": "GetContactPersonsByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/conceptEmployeeContactPerson"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Concept employee contact person"
],
"description": "__Activity name :__ PostContactPersonByConceptEmployeeId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ No default values\n\nCreate a new contact person for a concept employee\n",
"summary": "Create a contact person for a concept employee",
"operationId": "PostContactPersonByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Contact person to add to the concept employee.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/conceptEmployeeContactPerson"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/conceptEmployeeContactPerson"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/contactpersons/metadata": {
"get": {
"tags": [
"Concept employee contact person"
],
"description": "__Activity name :__ GetContactPersonMetadataByConceptEmployeeId\n\nGet metadata for creating a new contact person\n",
"summary": "Metadata for contact person creation",
"operationId": "GetContactPersonMetadataByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/metadata"
}
}
}
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/contactpersons/{contactPersonId}": {
"put": {
"tags": [
"Concept employee contact person"
],
"description": "__Activity name :__ PutContactPersonByContactPersonId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n\nEdit the details of a contact person\n",
"summary": "Edit a contact person",
"operationId": "PutContactPersonByContactPersonId",
"parameters": [
{
"$ref": "#/components/parameters/contactPersonId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Contact person to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/conceptEmployeeContactPerson"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/conceptEmployeeContactPerson"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Concept employee contact person"
],
"description": "__Activity name :__ DeleteContactPersonByContactPersonId\n\nDelete an existing contact person (for a concept employee)\n",
"summary": "Delete a specific contact person",
"operationId": "DeleteContactPersonByContactPersonId",
"parameters": [
{
"$ref": "#/components/parameters/contactPersonId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/contactpersons/{contactPersonId}/metadata": {
"get": {
"tags": [
"Concept employee contact person"
],
"description": "__Activity name :__ GetContactPersonMetadataByContactPersonId\n\nGet metadata for editing an existing contact person\n",
"summary": "Metadata for contact person update",
"operationId": "GetContactPersonMetadataByContactPersonId",
"parameters": [
{
"$ref": "#/components/parameters/contactPersonId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/metadata"
}
}
}
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/notifications": {
"get": {
"tags": [
"Notification"
],
"description": "__Activity name :__ GetNotificationsByEmployerId\n\nGet a list of unread notifications for an employer\n",
"summary": "Get a list of notifications for an employer.",
"operationId": "GetNotificationsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notification"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/notifications": {
"get": {
"tags": [
"Notification"
],
"description": "__Activity name :__ GetNotificationsByBearerToken\n\nReturns an array of notifications which are accessible for the current user. The list contains a isRead parameter. The list is structured by employer and administration level.\n",
"summary": "Notifications at providerlevel.",
"operationId": "GetNotificationsByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/acceptAsyncorSync"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/includeRead"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notificationProvider"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Notification"
],
"description": "__Activity name :__ PatchNotificationsByEmployerId\n\nMark notifications as read\n",
"summary": "Mark one or more notifications as read.",
"operationId": "PatchNotifications",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "array of notifications to be changed",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notificationPatch"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/notifications/summary": {
"get": {
"tags": [
"Notification"
],
"description": "__Activity name :__ GetNotificationsSummaryByBearerToken\n\nGet a list of employers with for each employer the number of unread notifications.\n",
"summary": "Number of unread notifications per employer.",
"operationId": "GetNotificationsSummaryByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/startDateOptional"
},
{
"$ref": "#/components/parameters/endDateOptional"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notificationSummary"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/mutual/employers/notifications": {
"patch": {
"tags": [
"Notification"
],
"description": "__Activity name :__ PatchNotificationsByBearerToken\n\nMark notifications as read in a collective process\n",
"summary": "Mark multiple notifications as read.",
"operationId": "PatchNotificationsByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "array of notifications to be changed",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notificationPatchCollective"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/notifications/{notificationId}": {
"get": {
"tags": [
"Notification"
],
"description": "__Activity name :__ GetNotificationByNotificationId\nRetrieve a specific notification by its unique identifier. The notification is returned with the employer and employee information.\n",
"summary": "Get notification by ID.",
"operationId": "GetNotificationByNotificationId",
"parameters": [
{
"$ref": "#/components/parameters/notificationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/notificationProvider"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/announcements": {
"get": {
"tags": [
"Announcement"
],
"description": "__Activity name :__ GetAnnouncementsByEmployerId\nGet a list of announcements for an employer. The list contains a isRead parameter.\n",
"summary": "Get a list of announcements for an employer.",
"operationId": "GetAnnouncementsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/announcement"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/announcements": {
"get": {
"tags": [
"Announcement"
],
"description": "__Activity name :__ GetAnnouncementsByBearerToken\n\nReturns an array of announcements for the current user. By default the list includes announcements that are unread and not expired. \n\nAn announcements has a subject and a description. The subject is always included. By default the description is not included in the response. Use the includeDescription parameter to include the description in the response. \n",
"summary": "Announcements at provider level.",
"operationId": "GetAnnouncementsByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/acceptAsyncorSync"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/includeRead"
},
{
"$ref": "#/components/parameters/includeExpired"
},
{
"$ref": "#/components/parameters/includeDescription"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/announcementProvider"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Announcement"
],
"description": "__Activity name :__ PatchAnnouncementsByEmployerId\nMark announcements as read\n",
"summary": "Mark one or more announcements as read.",
"operationId": "PatchAnnouncements",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "array of announcements to be changed",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/announcementPatch"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/announcements/summary": {
"get": {
"tags": [
"Announcement"
],
"description": "__Activity name :__ GetAnnouncementsSummaryByBearerToken\nGet a list of employers with for each employer the number of unread announcements.\n",
"summary": "Unread announcements per employer.",
"operationId": "GetAnnouncementsSummaryByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/announcementSummary"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/mutual/employers/announcements": {
"patch": {
"tags": [
"Announcement"
],
"description": "__Activity name :__ PatchAnnouncementsByBearerToken\nMark announcements as read in a collective process\n",
"summary": "Mark multiple announcements as read.",
"operationId": "PatchAnnouncementsByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "array of announcements to be changed",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/announcementPatchCollective"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/announcements/{announcementId}": {
"get": {
"tags": [
"Announcement"
],
"description": "__Activity name :__ GetAnnouncementByAnnouncementId\n\nRetrieve a single announcement by its ID for a specific employer.\n",
"summary": "Details of a single announcement",
"operationId": "GetAnnouncementByAnnouncementId",
"parameters": [
{
"$ref": "#/components/parameters/announcementId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/announcementProviderDetail"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments": {
"get": {
"tags": [
"Employment"
],
"description": "__Activity name :__ GetEmploymentsByEmployerId\n\nGet a list of employments for an employer\n\nThis 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.\n",
"summary": "List of employments for an employer",
"operationId": "GetEmploymentsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2019-12-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employmentResponse2019-12-16"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/minimized": {
"get": {
"tags": [
"Employment"
],
"description": "__Activity name :__ GetEmploymentsMinimizedByEmployerId\n\nGet 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.\n\nThis 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.\n",
"summary": "List of employments with fewer fields for performance reasons",
"operationId": "GetEmploymentsMinimizedByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2019-12-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employmentMinimizedResponse2019-12-16"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/comprehensive": {
"get": {
"tags": [
"Employment"
],
"description": "__Activity name :__ GetEmploymentsComprehensiveByEmployerId\n\n__Availability:__ This is endpoint is available for the Loket application only. It is not available for external parties\n\nGet a list of employments for an employer. With this version we introduced the \"Comprehensive\" resource which contains additional entities. \n\nThis 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.\n",
"summary": "List of employments with additional entities",
"operationId": "GetEmploymentsComprehensiveByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/removeEmptyLines"
},
{
"$ref": "#/components/parameters/includeHistoricAndFutureData"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2019-12-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employmentComprehensiveResponse2019-12-16"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/employments": {
"get": {
"tags": [
"Employment"
],
"description": "__Activity name :__ GetEmploymentsByEmployeeId\n\nGet the list of employments for an employee\n",
"summary": "List of employments for an employee",
"operationId": "GetEmploymentsByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2019-12-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employmentResponse2019-12-16"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Create employment"
],
"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 `../v2/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.
\"\n",
"summary": "Create employment for existing employee",
"operationId": "PostEmploymentByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "The request body contains an object for the additional employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/createEmploymentObject"
}
}
}
},
"responses": {
"201": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}": {
"get": {
"tags": [
"Employment"
],
"description": "__Activity name :__ GetEmploymentByEmploymentId\n\nGet the details for an employment\n",
"summary": "Details of an employment",
"operationId": "GetEmploymentByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2019-12-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employmentResponseWithClaAndWageModel2019-12-16"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Employment"
],
"description": "__Activity name :__ PutEmploymentByEmploymentId\n\nEdit the details of an employment\n\nPossible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the URL\n",
"summary": "Edit the details of an employment",
"operationId": "PutEmploymentByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Employment to edit",
"required": true,
"content": {
"application/json;version=2019-12-16": {
"schema": {
"$ref": "#/components/schemas/employmentResponse2019-12-16"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2019-12-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employmentResponse2019-12-16"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Employment"
],
"description": "__Activity name :__ PatchTypeOfEmploymentCategoryTypeFieldsByEmploymentId\n\nEdit a small subset of fields of an employment. \n\nPossible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the URL\n",
"summary": "Edit the type of an employment",
"operationId": "PatchTypeOfEmploymentCategoryTypeFieldsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Employment to edit",
"required": true,
"content": {
"application/json;version=2019-12-16": {
"schema": {
"$ref": "#/components/schemas/employmentCategoryTypeFieldsObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2019-12-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employmentCategoryTypeFieldsObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Employment"
],
"description": "__Activity name :__ DeleteEmploymentByEmploymentId\n\nDelete an employment. If the person linked to the employment no longer has any other employments, the person will also be deleted.\n\nDeleting an employment is only possible under specific conditions. Information on these conditions can be obtained with: GetDeleteEmploymentInformationByEmploymentId\n",
"summary": "Delete an employment",
"operationId": "DeleteEmploymentByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/transitioncompensation": {
"post": {
"tags": [
"Create employment"
],
"description": "__Activity name :__ PostTransitionCompensationEmploymentByEmploymentId\n\nCreate an additional employment for an already existing and terminated employment with the sole purpose to pay out a transition compensation.\n",
"summary": "Create transition compensation employment for existing employment",
"operationId": "PostTransitionCompensationEmploymentByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"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.",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/employeeprofile": {
"patch": {
"tags": [
"Activate employee profile"
],
"description": "__Activity name :__ PatchEmployeeProfileByEmploymentId\n\nCreate Fondsen, Grondslagen and toeslagen based on the employment's employeeProfile.\n",
"summary": "Activate employee profile for the employment",
"operationId": "PatchEmployeeProfileByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employeeProfile"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employeeProfileResponse"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/deleteinformation": {
"get": {
"tags": [
"Employment"
],
"description": "__Activity name :__ GetDeleteEmploymentInformationByEmploymentId\n\nGet information about the validations that the employment must meet in order to be allowed to delete.\n",
"summary": "Delete employment information",
"operationId": "GetDeleteEmploymentInformationByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2019-12-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/deleteEmploymentInformation"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/terminate": {
"patch": {
"tags": [
"Employment"
],
"description": "__Activity name :__ PatchTerminateByEmploymentId\n\nTerminate an employment. Effectively, the `endDate` of the employment will be set to the given date.
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.
\n\nIf the termination needs to be reversed use the `../employments/{employmentId}/reinstate` endpoint.
If the termination needs to be changed, use this endpoint to revise the termination data
\n\nThe metadata for endOfEmploymentReason and endOfEmploymentReasonTaxAuthorities are included in the 'regular' metadata-endpoint of the Employment resource. \n",
"summary": "Terminate an employment.",
"operationId": "PatchTerminateByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "The request body contains an object containing fields related to termination of an employment.",
"required": true,
"content": {
"application/json;version=2019-12-16": {
"schema": {
"$ref": "#/components/schemas/employmentTermination20181231"
}
},
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employmentTermination20180101"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2019-12-16": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
},
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/reinstate": {
"patch": {
"tags": [
"Employment"
],
"description": "__Activity name :__ PatchReinstateByEmploymentId\n\nreinstate for an employment.
Effectively, termination is reversed by using this endpoint and therefore the employment will be considered active again. \n\nMaak een uitdienst melding ongedaan.
Effectief gezien, 'datum uit dienst' gegevens worden teruggedraaid waardoor het dienstverband weer als actief zal worden beschouwd in Loket
\n",
"summary": "Undo termination for an employment.",
"operationId": "PatchReinstateByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"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.",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/correctstartdate": {
"patch": {
"tags": [
"Employment"
],
"description": "__Activity name :__ PatchCorrectStartDateByEmploymentId\n\nEdit 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). \n\n\n * With a correction of the starting date, you are responsible for the associated notifications. \n",
"summary": "Correct the start (employment) date for an employment.",
"operationId": "PatchCorrectStartDateByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "The request body contains an object containing fields related to termination of an employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employmentStartDate"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/payrollperioddata": {
"patch": {
"tags": [
"Payroll period data"
],
"description": "
This endpoint is the Collective variant of PatchPayrollPeriodDataByEmploymentId \n\n__Activity name :__ PatchCollectivePayrollPeriodDataByEmployerId\n\nThis endpoint can be used to patch payroll period data for several employments of an employer.\n",
"summary": "Insert or update payroll period data for several employments",
"operationId": "PatchCollectivePayrollPeriodDataByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Payroll period data to add to or update for the employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollDataPatchCollective"
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/payrollperioddata": {
"get": {
"tags": [
"Payroll period data"
],
"description": "__Activity name :__ GetPayrollPeriodDataByEmploymentId
Get a list of all payroll period data for an employment. Payroll period data relates to a single payroll period.\n",
"summary": "list of payroll period data",
"operationId": "GetPayrollPeriodDataByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollDataGetPut2018-01-01"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Payroll period data"
],
"description": "__Activity name :__ PostPayrollPeriodDataByEmploymentId
Create a payroll period date record for an employment
__Metadata :__
Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL
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
__Default values :__
* Default values may be acquired by adding `/defaults` (GET) to the POST url\n",
"summary": "Create an payroll period data record for an employment",
"operationId": "PostPayrollPeriodDataByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Payroll variables to add to the employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/payrollDataPost2018-01-01"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payrollDataGetPut2018-01-01"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Payroll period data"
],
"description": "**This endpoint is the REST alternative to the ImporteerGegevens (Variabele Gegevens) SOAP webservice functionality**
__Activity name :__ PatchPayrollPeriodDataByEmploymentId
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 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.\nBased on the current state of the database Loket will either insert a new record or update the existing record with the supplied data.\n* 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.
\n* 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.
__Metadata :__
Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PATCH URL
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
__Default values :__
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.
__Extra background reading :__
It may be useful to read more about payroll period data (variabele gegevens, mutaties) on the Loket [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.
\n",
"summary": "Insert or update payroll period data",
"operationId": "PatchPayrollPeriodDataByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"requestBody": {
"description": "Payroll period data to add to or update for the employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/payrollDataPatch2018-01-01"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/payrollperioddata/{payrollperioddataId}": {
"get": {
"tags": [
"Payroll period data"
],
"description": "__Activity name :__ GetPayrollPeriodDataByPayrollPeriodDataId
Get the details of payroll period data\n",
"summary": "Details of a payroll period data",
"operationId": "GetPayrollPeriodDataByPayrollPeriodDataId",
"parameters": [
{
"$ref": "#/components/parameters/payrollperioddataId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payrollDataGetPut2018-01-01"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Payroll period data"
],
"description": "__Activity name :__ PutPayrollPeriodDataByPayrollPeriodDataId
Edit the details for payroll period data
__Metadata :__
Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL
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
\n",
"summary": "Edit the details of an payroll period data",
"operationId": "PutPayrollPeriodDataByPayrollPeriodDataId",
"parameters": [
{
"$ref": "#/components/parameters/payrollperioddataId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Payroll period data to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/payrollDataGetPut2018-01-01"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payrollDataGetPut2018-01-01"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Payroll period data"
],
"description": "__Activity name:__ DeletePayrollPeriodDataByPayrollPeriodDataId\n\nDelete a payroll period data record for the employment\n",
"summary": "Delete a specific payroll period data record",
"operationId": "DeletePayrollPeriodDataByPayrollPeriodDataId",
"parameters": [
{
"$ref": "#/components/parameters/payrollperioddataId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/benefitsanddeductions": {
"get": {
"tags": [
"Benefits and deductions"
],
"description": "__Activity name :__ GetBenefitsAndDeductionsByEmploymentId\n\nGet a list of benefits and deductions for the employment\n",
"summary": "list of benefits and deductions",
"operationId": "GetBenefitsAndDeductionsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/benefitsAndDeductionsGetAndPut2018-01-01"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Benefits and deductions"
],
"description": "__Activity name :__ PostBenefitsAndDeductionsByEmploymentId\n\nAdd a benefit or deduction for the employment\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults` to the POST URL.\n",
"summary": "Add a benefit or deduction record for the employment",
"operationId": "PostbenefitsAndDeductionsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "benefits and deductions record add to the employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/benefitsAndDeductionsPost2018-01-01"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/benefitsAndDeductionsGetAndPut2018-01-01"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/benefitsAndDeductions/{benefitsanddeductionsId}": {
"get": {
"tags": [
"Benefits and deductions"
],
"description": "__Activity name :__ GetBenefitsAndDeductionsBybenefitsAndDeductionsId\n\nGet a benefit or deduction for the employment\n",
"summary": "Detail of a benefit or deduction record",
"operationId": "GetBenefitsAndDeductionsBybenefitsAndDeductionsId",
"parameters": [
{
"$ref": "#/components/parameters/benefitsanddeductionsId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/benefitsAndDeductionsGetAndPut2018-01-01"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Benefits and deductions"
],
"description": "__Activity name :__ PutBenefitsAndDeductionsByBenefitsAndDeductionsId\n\nUpdate a benefit or deduction for the employment\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n",
"summary": "Edit the details of a benefit or deduction record",
"operationId": "PutBenefitsAndDeductionsByBenefitsAndDeductionsId",
"parameters": [
{
"$ref": "#/components/parameters/benefitsanddeductionsId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "data to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/benefitsAndDeductionsGetAndPut2018-01-01"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/benefitsAndDeductionsGetAndPut2018-01-01"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Benefits and deductions"
],
"description": "__Activity name :__ DeleteBenefitsAndDeductionsByBenefitsAndDeductionsId\n\nDelete a benefit or deduction for the employment\n",
"summary": "Delete a specific benefit or deduction record",
"operationId": "DeleteBenefitsAndDeductionsByBenefitsAndDeductionsId",
"parameters": [
{
"$ref": "#/components/parameters/benefitsanddeductionsId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/import/benefitsanddeductions\"": {
"get": {
"tags": [
"Benefits and deductions import"
],
"description": "__Activity name :__ GetBenefitsAndDeductionsImportDataByPayrollAdministrationId\n\nReturns, for the given payrolladministration, a set of data that can be used as a base for importing benefits and deductions through a csv file.\n\nNote that on importing, the columnnames must be in Dutch. (Clientnr,\tPersnrVerl,\tPersnr,\tNaam,\tIngangsdatum, Component, Omschrijving, Toeslag )\n",
"summary": "Get data to create an importfile",
"operationId": "GetBenefitsAndDeductionsImportDataByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BenefitsAndDeductionsImportData"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Benefits and deductions import"
],
"description": "__Activity name :__ PostBenefitsAndDeductionsImportDataByPayrollAdministrationId\n\n\n\nImports a csv file containing benefits and deduction records.\n",
"summary": "Import benefits and deductions via a csv file",
"operationId": "PostBenefitsAndDeductionsImportDataByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "csv file to be uploaded.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/importFile"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"413": {
"$ref": "#/components/responses/requestEntityTooLarge"
},
"415": {
"$ref": "#/components/responses/unsupportedMediaType"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/benefitsanddeductions": {
"post": {
"tags": [
"Collective benefits and deductions"
],
"description": "__Activity name :__ PostCollectiveBenefitsAndDeductionsByEmployerId\n\nCreate new benefits and deduction records for multiple employments of an employer\n",
"summary": "Create benefits and deductions for multiple employments",
"operationId": "PostCollectiveBenefitsAndDeductionsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "BenefitsAndDeductions to add.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/benefitsAndDeductionsCollectivePost"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Collective benefits and deductions"
],
"description": "__Activity name :__ PutCollectiveBenefitsAndDeductionsByEmployerId\n\nSet the endDate for benefits and deduction records for multiple employments of an employer\n",
"summary": "Close benefits and deductions for multiple employments",
"operationId": "PutCollectiveBenefitsAndDeductionsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "BenefitsAndDeductions to put.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/benefitsAndDeductionsCollectivePut"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/signalpaygradeadjustment": {
"patch": {
"tags": [
"Collective signal paygrade adjustment"
],
"description": "__Activity name :__ PatchCollectiveSignalPayGradeAdjustmentByEmployerId\n",
"summary": "Collective set SignalPayGradeAdjustment",
"operationId": "PatchCollectiveSignalPayGradeAdjustmentByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "The request body contains an array of employments.",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signalPaygradeAdjustment"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/wageprojection": {
"post": {
"tags": [
"Wage projection"
],
"description": "__Activity name :__ PostWageProjectionByEmploymentId\n\nThis endpoint can only be used for employments that are already known in the Loket system.\n\n__Metadata :__ No metadata endpoint available for this controller endpoint.\n\n__Defaults :__ No defaults endpoint available for this controller endpoint.",
"summary": "Perform a wage projection",
"operationId": "PostWageProjectionByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "object",
"$ref": "#/components/schemas/wageProjectionInput"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payrollResults"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/wageprojection/basedOnDefaultClaConfiguration": {
"post": {
"tags": [
"Wage projection"
],
"description": "__Activity name :__ PostWageprojectionBasedOnDefaultClaConfigurationByEmploymentId\n\nThis 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.\n\n__Metadata :__ No metadata endpoint available for this controller endpoint.\n\n__Defaults :__ No defaults endpoint available for this controller endpoint.",
"summary": "Perform a wage projection based on a default CLA configuration",
"operationId": "PostWageprojectionBasedOnDefaultClaConfigurationByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "object",
"$ref": "#/components/schemas/claWageProjectionInput"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payrollResults"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/wageprojection/cladata/{collectiveLaborAgreementId}": {
"get": {
"tags": [
"Wage projection"
],
"description": "__Activity name :__ GetClaDataForWageProjectionByCollectiveLaborAgreementId\n\nGet 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.\n",
"summary": "Wage projection Collective labor agreements defaults",
"operationId": "GetClaDataForWageProjectionByCollectiveLaborAgreementId",
"parameters": [
{
"$ref": "#/components/parameters/collectiveLaborAgreementId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/claData"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/wageprojection/collectivelaboragreements": {
"get": {
"tags": [
"Wage projection"
],
"description": "__Activity name :__ GetCollectiveLaborAgreementsByUserId\n\nGet a list of all collective labor agreements (CLA) accessible to the current user\n",
"summary": "List of collective labor agreements (CLA)",
"operationId": "GetCollectiveLaborAgreementsByUserId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/collectiveLaborAgreement"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/educations": {
"get": {
"tags": [
"Education"
],
"description": "__Activity name :__ GetEducationsByEmployeeId\n\nGet list of educations for an employee\n",
"summary": "List of educations for an employee",
"operationId": "GetEducationsByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employeeEducation"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Education"
],
"description": "__Activity name :__ PostEducationByEmployeeId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ No default values\n\nCreate a new education for an employee\n",
"summary": "Create a education for an employee",
"operationId": "PostEducationByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Education to add to the employee.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employeeEducation"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employeeEducation"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/educations/{employeeEducationId}": {
"get": {
"tags": [
"Education"
],
"description": "__Activity name :__ GetEducationByEducationId \n\nGet the details of a single education\n",
"summary": "Details of a single education",
"operationId": "GetEducationByEducationId",
"parameters": [
{
"$ref": "#/components/parameters/employeeEducationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employeeEducation"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Education"
],
"description": "__Activity name :__ PutEducationByEducationId \n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n\nEdit the details of a education\n",
"summary": "Edit a Education",
"operationId": "PutEducationByEducationId",
"parameters": [
{
"$ref": "#/components/parameters/employeeEducationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Education to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employeeEducation"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employeeEducation"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Education"
],
"description": "__Activity name :__ DeleteEducationByEducationId\n\nDelete an existing Education (for an employee)\n",
"summary": "Delete a specific education",
"operationId": "DeleteEducationByEducationId",
"parameters": [
{
"$ref": "#/components/parameters/employeeEducationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/declarations": {
"get": {
"tags": [
"Declarations"
],
"summary": "List of declarations for an employment",
"operationId": "GetDeclarationsByEmploymentId",
"description": "__Activity name :__ GetDeclarationsByEmploymentId\n\nReturns a list of declarations for the employments of the employer\n",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/declarationObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Declarations"
],
"summary": "Create a declaration for an employment",
"operationId": "PostDeclarationByEmploymentId",
"description": "__Activity name :__ PostDeclarationByEmploymentId\n\nAdd a declaration for an employment. This can be only be done by the employee.\n",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/declarationObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/declarationObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/declarations/{declarationId}": {
"get": {
"tags": [
"Declarations"
],
"description": "__Activity name :__ GetDeclarationByDeclarationId\n\nGet the details of a declaration\n",
"summary": "Details of a declaration",
"operationId": "GetDeclarationByDeclarationId",
"parameters": [
{
"$ref": "#/components/parameters/declarationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/declarationObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Declarations"
],
"summary": "Edit a declaration for an employment",
"operationId": "PutDeclarationByDeclarationId",
"description": "__Activity name :__ PutDeclarationByDeclarationId\n\nEdit a declaration for an employment. This is usually done by the employee.\n",
"parameters": [
{
"$ref": "#/components/parameters/declarationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/declarationObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/declarationObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Declarations"
],
"description": "__Activity name :__ DeleteDeclarationByDeclarationId\n\nDelete a declaration including attachment if applicable.\n",
"summary": "Delete a declaration",
"operationId": "DeleteDeclarationByDeclarationId",
"parameters": [
{
"$ref": "#/components/parameters/declarationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/declarations/{declarationId}/audittrail": {
"get": {
"tags": [
"Declarations"
],
"description": "__Activity name :__ GetDeclarationAuditTrailByDeclarationId\n\nGet the audit trail of a declaration\n",
"summary": "Audit trail of a declaration",
"operationId": "GetDeclarationAuditTrailByDeclarationId",
"parameters": [
{
"$ref": "#/components/parameters/declarationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/declarationsAuditTrail"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/declarations/analyze/receipt": {
"post": {
"tags": [
"Declarations"
],
"description": "__Activity name :__ PostAnalyzeReceiptByEmploymentId\n\nPost a receipt for OCR.\n",
"summary": "Upload a receipt to analyze",
"operationId": "PostAnalyzeReceiptByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Document to be uploaded as attachment to the declaration.",
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/receiptOcrResults"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/wages": {
"get": {
"tags": [
"Wage"
],
"description": "__Activity name :__ GetWagesByEmploymentId\n\nGet the list of wages for the employment\n",
"summary": "List of wages for an employment",
"operationId": "GetWagesByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/wage-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Wage"
],
"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.
\n",
"summary": "Create an wage for an employment",
"operationId": "PostWageByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Wage to add to the employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/wage-2"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/wage-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/wages/{wageId}": {
"get": {
"tags": [
"Wage"
],
"description": "__Activity name :__ GetWageByWageId\n\nGet the details of a single wage\n",
"summary": "Details of a single wage",
"operationId": "GetWageByWageId",
"parameters": [
{
"$ref": "#/components/parameters/wageId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/wage-2"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Wage"
],
"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.
\n",
"summary": "Edit a wage",
"operationId": "PutWageByWageId",
"parameters": [
{
"$ref": "#/components/parameters/wageId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Wage to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/wage-2"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/wage-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Wage"
],
"description": "__Activity name :__ DeleteWageByWageId\n\nDelete a wage record for the employment\n",
"summary": "Delete a specific wage record",
"operationId": "DeleteWageByWageId",
"parameters": [
{
"$ref": "#/components/parameters/wageId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/import/wage\"": {
"get": {
"tags": [
"Wage import"
],
"description": "__Activity name :__ GetWageImportDataByPayrollAdministrationId\n\nReturns, for the given payrolladministration, a set of data that can be used as a base for importing wage through a csv file.\n\nNote that on importing, the columnnames must be in Dutch. (Clientnr\tPersnrVerl\tPersnr\tNaam\tIngangsdatum\tBasisloon BasisloonEenheid Nettoloon NettoloonEenheid Loonkosten LoonkostenEenheid)\n",
"summary": "Get data to create an importfile",
"operationId": "GetWageImportDataByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WageImportData"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Wage import"
],
"description": "__Activity name :__ PostWageImportDataByPayrollAdministrationId\n\n\n\nImports a csv file containing wage records.\n",
"summary": "Import wage via a csv file",
"operationId": "PostWageImportDataByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "csv file to be uploaded.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/importFile"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"413": {
"$ref": "#/components/responses/requestEntityTooLarge"
},
"415": {
"$ref": "#/components/responses/unsupportedMediaType"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/wages": {
"post": {
"tags": [
"Collective wage"
],
"description": "__Activity name :__ PostCollectiveWageByEmployerId\n\nCreate new grosswage records for multiple employments of an employer\n",
"summary": "Create wages for multiple employments",
"operationId": "PostCollectiveWageByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Wages to add.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/wageCollective"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/minimumwage": {
"get": {
"tags": [
"Wage"
],
"description": "__Activity name :__ GetMinimumWageByEmploymentId\n\nThis endpoint calculates the minimumwage for an employment.\n",
"summary": "Minimumwage for an employment",
"operationId": "GetMinimumWageByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/referenceDateOptional"
},
{
"$ref": "#/components/parameters/paygradeKey-2"
},
{
"$ref": "#/components/parameters/payscaleKey-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/minimumwage"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/costperhour": {
"get": {
"tags": [
"Cost per hour"
],
"description": "__Activity name:__ GetCostPerHourByEmploymentId
Get the list of costs per hour for an employment
\n",
"summary": "List of costs per hour for an employment",
"operationId": "GetCostPerHourByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/includeEstimation"
},
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/costPerHour"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Cost per hour"
],
"description": "__Activity name :__ PostCostPerHourByEmploymentId\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.\n\n__Defaults:__ Defaults can be acquired(GET)by adding `/defaults` to the POST URL.\n",
"summary": "Add a cost per hour for an employment",
"operationId": "PostCostPerHourByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a cost per hour",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/costPerHour"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/costPerHour"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/costperhour/{costPerHourId}": {
"get": {
"tags": [
"Cost per hour"
],
"description": "__Activity name :__ GetCostPerHourByCostPerHourId\n\nGet the details of a cost per hour record\n",
"summary": "Details of cost per hour",
"operationId": "GetCostPerHourByCostPerHourId",
"parameters": [
{
"$ref": "#/components/parameters/costPerHourId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/costPerHour"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Cost per hour"
],
"description": "__Activity name :__ PutCostperhourByCostperhourId\n\n__Metadata :__ No metadata.\n",
"summary": "Edit a cost per hour record",
"operationId": "PutCostperhourByCostperhourId",
"parameters": [
{
"$ref": "#/components/parameters/costPerHourId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/costPerHourPut"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/costPerHour"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Cost per hour"
],
"description": "__Activity name :__ DeleteCostPerHourByCostPerHourId\n\nDelete an existing cost per hour record\n",
"summary": "Delete a cost per hour record",
"operationId": "DeleteCostPerHourByCostPerHourId",
"parameters": [
{
"$ref": "#/components/parameters/costPerHourId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/workinghours": {
"get": {
"tags": [
"Working hours"
],
"description": "__Activity name :__ GetWorkingHoursByEmploymentId
Get the list of working hours for an employment
\n",
"summary": "List of working hours for an employment",
"operationId": "GetWorkingHoursByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/workinghours"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Working hours"
],
"description": "__Activity name :__ PostWorkingHoursByEmploymentId
Create a new working hours record for an employment
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.
A new or changed startDate affects the endDate of its preceding record.
When POST-ing a new record, the startDate must be greater then the preceding record's startDate.\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.\n",
"summary": "Create the working hours for an employment",
"operationId": "PostWorkingHoursByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Working hours to add to the employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/workinghours"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/workinghours"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/workinghours/{workinghoursId}": {
"get": {
"tags": [
"Working hours"
],
"description": "__Activity name :__ GetWorkingHoursByWorkingHoursId
Get the details of a working hours record\n",
"summary": "Details of the working hours",
"operationId": "GetWorkingHoursByWorkingHoursId",
"parameters": [
{
"$ref": "#/components/parameters/workinghoursId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/workinghours"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Working hours"
],
"description": "__Activity name :__ PutWorkingHoursByWorkingHoursId
Create a new working hours record for an employment
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.
A new or changed startDate affects the endDate of its preceding record.
When PUT-ing a new record, the startDate must be greater then the preceding record's startDate.\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n",
"summary": "Edit the working hours",
"operationId": "PutWorkingHoursByWorkingHoursId",
"parameters": [
{
"$ref": "#/components/parameters/workinghoursId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Working hours to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/workinghours"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/workinghours"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Working hours"
],
"description": "__Activity name :__ DeleteWorkingHoursByWorkingHoursId
Delete an existing working hours record (for an employment)\n",
"summary": "Delete a specific working hours record",
"operationId": "DeleteWorkingHoursByWorkingHoursId",
"parameters": [
{
"$ref": "#/components/parameters/workinghoursId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/organizationalentities": {
"get": {
"tags": [
"Organizational entity"
],
"description": "__Activity name:__ GetOrganizationalEntitiesByEmploymentId
Get the list of organizational entities for an employment
\n",
"summary": "List of organizational entities for an employment",
"operationId": "GetOrganizationalEntitiesByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/organizationalEntity-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Organizational entity"
],
"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.
\n",
"summary": "Create an organizational entity for an employment",
"operationId": "PostOrganizationalEntityByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Organizational entity to add to the employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/organizationalEntity-2"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/organizationalEntity-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/organizationalentities/{organizationalEntityId}": {
"get": {
"tags": [
"Organizational entity"
],
"description": "__Activity name:__ GetOrganizationalEntityByOrganizationalEntityId\n\nGet the details of organizational entity\n",
"summary": "Details of an organizational entity",
"operationId": "GetOrganizationalEntityByOrganizationalEntityId",
"parameters": [
{
"$ref": "#/components/parameters/organizationalEntityId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/organizationalEntity-2"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Organizational entity"
],
"description": "__Activity name:__ PutOrganizationalEntityByOrganizationalEntityId\n\nEdit the details for an organizational entity\n\nPossible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n",
"summary": "Edit the details of an organizational entity",
"operationId": "PutOrganizationalEntityByOrganizationalEntityId",
"parameters": [
{
"$ref": "#/components/parameters/organizationalEntityId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Organizational entity to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/organizationalEntity-2"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/organizationalEntity-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Organizational entity"
],
"description": "__Activity name:__ DeleteOrganizationalEntityByOrganizationalEntityId\n\nDelete a organizational entity for the employment\n",
"summary": "Delete a specific organizational entity record",
"operationId": "DeleteOrganizationalEntityByOrganizationalEntityId",
"parameters": [
{
"$ref": "#/components/parameters/organizationalEntityId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/paymentinformationsepa": {
"get": {
"tags": [
"Payment information"
],
"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.
\n",
"summary": "Get a list of payment information sepa",
"operationId": "GetPaymentInformationSepaByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/paymentinformationsepa2018-01-01"
}
}
}
}
]
}
},
"application/json;version=YYYY-MM-DD": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/paymentinformationsepaYYYY-MM-DD"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Payment information"
],
"description": "__Activity name :__ PostPaymentInformationSepaByEmploymentId\n\nCreate a new Payment information SEPA record for an employment.
For each unique payroll component there can only be one payment record per employment.\n\n__Metadata :__ Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the URL\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.\n",
"summary": "create a new payment information sepa record",
"operationId": "PostPaymentInformationSepaByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Payment information sepa record to add to the employment",
"required": true,
"content": {
"applicationjson;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/paymentinformationsepa2018-01-01"
}
},
"applicationjson;version=YYYY-MM-DD": {
"schema": {
"$ref": "#/components/schemas/paymentinformationsepaYYYY-MM-DD"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/paymentinformationsepa2018-01-01"
}
}
}
]
}
},
"application/json;version=YYYY-MM-DD": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/paymentinformationsepaYYYY-MM-DD"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/paymentinformationsepa/{paymentInformationSepaId}": {
"get": {
"tags": [
"Payment information"
],
"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.
\n",
"summary": "Get the details of a payment information sepa",
"operationId": "GetPaymentInformationSepaBypaymentInformationSepaId",
"parameters": [
{
"$ref": "#/components/parameters/paymentInformationSepaId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/paymentinformationsepa2018-01-01"
}
}
}
]
}
},
"application/json;version=YYYY-MM-DD": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/paymentinformationsepaYYYY-MM-DD"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Payment information"
],
"description": "__Activity name :__ PutPaymentInformationSepaByPaymentInformationSepaId\n\nEdit an existing SEPA payment-record (for an employment).\nFor each unique payroll component there can only be one payment record per employment.\nPossible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the URL\n",
"summary": "change the details of a payment information sepa",
"operationId": "PutPaymentInformationSepaByPaymentInformationSepaId",
"parameters": [
{
"$ref": "#/components/parameters/paymentInformationSepaId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "SEPA payment record to edit",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/paymentinformationsepa2018-01-01"
}
},
"application/json;version=YYYY-MM-DD": {
"schema": {
"$ref": "#/components/schemas/paymentinformationsepaYYYY-MM-DD"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/paymentinformationsepa2018-01-01"
}
}
}
]
}
},
"application/json;version=YYYY-MM-DD": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/paymentinformationsepaYYYY-MM-DD"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Payment information"
],
"description": "__Activity name :__ DeletePaymentInformationSepaByPaymentInformationSepaId\n\nDelete an existing SEPA payment-record (for an employment)\n",
"summary": "Delete a specific SEPA payment-record record",
"operationId": "DeletePaymentInformationSepaBypaymentInformationSepaId",
"parameters": [
{
"$ref": "#/components/parameters/paymentInformationSepaId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/paymentinformationsepaseparatepayments": {
"get": {
"tags": [
"Payment information separate payments"
],
"description": "__Activity name :__ GetPaymentInformationSepaSeparatePaymentByEmploymentId\n\nGet 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.\n",
"summary": "Get a list of payment information SEPA separate payment records",
"operationId": "GetPaymentInformationSepaSeparatePaymentByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/paymentinformationsepaseparatepayments"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Payment information separate payments"
],
"description": "__Activity name :__ PostPaymentInformationSepaSeparatePaymentByEmploymentId\n\nCreate a new payment information SEPA separate payment record for an employment.
\n\n__Metadata :__ Not applicable for this resource.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.\n",
"summary": "Create a new payment information SEPA separate payment record",
"operationId": "PostPaymentInformationSepaSeparatePaymentByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"applicationjson;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/paymentinformationsepaseparatepayments"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/paymentinformationsepaseparatepayments"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/paymentinformationsepaseparatepayments/{paymentInformationSepaSeparatePaymentId}": {
"get": {
"tags": [
"Payment information separate payments"
],
"description": "__Activity name :__ GetPaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId\n\nGet 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.\n",
"summary": "Get the details of a payment information SEPA separate payment record",
"operationId": "GetPaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId",
"parameters": [
{
"$ref": "#/components/parameters/paymentInformationSepaSeparatePaymentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/paymentinformationsepaseparatepayments"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Payment information separate payments"
],
"description": "__Activity name :__ PutPaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId\n\nEdit an existing separate payment-record (for an employment). For each unique payroll component there can only be one payment record per employment.\n\n__Metadata :__ Not applicable for this resource.\n",
"summary": "Edit the details of a payment information separate payment record",
"operationId": "PutPaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId",
"parameters": [
{
"$ref": "#/components/parameters/paymentInformationSepaSeparatePaymentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/paymentinformationsepaseparatepayments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/paymentinformationsepaseparatepayments"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Payment information separate payments"
],
"description": "__Activity name :__ DeletePaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId\n\nDelete an existing SEPA payment-record (for an employment)\n",
"summary": "Delete a payment information SEPA separate payment record",
"operationId": "DeletePaymentInformationSepaSeparatePaymentByPaymentInformationSepaSeparatePaymentId",
"parameters": [
{
"$ref": "#/components/parameters/paymentInformationSepaSeparatePaymentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/paymentinformationnonsepa": {
"get": {
"tags": [
"Payment information non-SEPA"
],
"description": "__Activity name :__ GetPaymentInformationNonSepaByEmploymentId\n\nGet 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. \n\nFor 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.\n\nFor each payroll component there can only be one payment Information record per employment.\n",
"summary": "Get a list of payment information non-SEPA",
"operationId": "GetPaymentInformationNonSepaByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/paymentInformationNonSepa"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Payment information non-SEPA"
],
"description": "__Activity name :__ PostPaymentInformationNonSepaByEmploymentId\n\nCreate 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.\n\n__Metadata :__ Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the URL\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.\n",
"summary": "Create a new payment information non-SEPA record",
"operationId": "PostPaymentInformationNonSepaByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Payment information non-SEPA record to add to the employment",
"required": true,
"content": {
"applicationjson;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/paymentInformationNonSepa"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/paymentInformationNonSepa"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/paymentinformationnonsepa/{paymentInformationNonSepaId}": {
"get": {
"tags": [
"Payment information non-SEPA"
],
"description": "__Activity name :__ GetPaymentInformationNonSepaByPaymentInformationNonSepaId\n\nGet the detail of a payment information non-SEPA record.\nFor a specific payroll component, the record indicates to which IBAN account number it should be related for the purpose of outgoing payments. \nThis includes, but is not limited to, the payment of wages for an employment.\nFor each payroll component there can only be one outgoing payment record per employment.\n",
"summary": "Get the details of a payment information non-SEPA",
"operationId": "GetPaymentInformationNonSepaBypaymentInformationNonSepaId",
"parameters": [
{
"$ref": "#/components/parameters/paymentInformationNonSepaId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/paymentInformationNonSepa"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Payment information non-SEPA"
],
"description": "__Activity name :__ PutPaymentInformationNonSepaByPaymentInformationNonSepaId\n\nEdit an existing payment information non-SEPA record (for an employment).\nFor each unique payroll component there can only be one payment record per employment.\n\n__Metadata :__ Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the URL\n",
"summary": "Change the details of a payment information non-SEPA",
"operationId": "PutPaymentInformationNonSepaByPaymentInformationNonSepaId",
"parameters": [
{
"$ref": "#/components/parameters/paymentInformationNonSepaId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/paymentInformationNonSepa"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/paymentInformationNonSepa"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Payment information non-SEPA"
],
"description": "__Activity name :__ DeletePaymentInformationNonSepaByPaymentInformationNonSepaId\n\nDelete a payment information non-SEPA record (for an employment)\n",
"summary": "Delete a payment information non-SEPA record",
"operationId": "DeletePaymentInformationNonSepaByPaymentInformationNonSepaId",
"parameters": [
{
"$ref": "#/components/parameters/paymentInformationNonSepaId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/attachmentsofearnings": {
"get": {
"tags": [
"Attachment of earnings"
],
"description": "__Activity name :__ GetAttachmentOfEarningsByEmploymentId\n\nGet a list of attachment of earnings records\n",
"summary": "Get a list of attachment of earnings records",
"operationId": "GetAttachmentOfEarningsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/attachmentOfEarnings"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Attachment of earnings"
],
"description": "__Activity name :__ PostAttachmentOfEarningsByEmploymentId\n\nCreate a new attachment of earnings record for an employment.\n\n__Metadata :__ Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the URL\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.\n",
"summary": "Create a new attachment of earnings record",
"operationId": "PostAttachmentOfEarningsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"applicationjson;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/attachmentOfEarnings"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/attachmentOfEarnings"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/attachmentsofearnings/{attachmentOfEarningsId}": {
"get": {
"tags": [
"Attachment of earnings"
],
"description": "__Activity name :__ GetAttachmentOfEarningsByAttachmentOfEarningsId\n\nGet the details of an attachment of earnings record\n",
"summary": "Get the details of an attachment of earnings record",
"operationId": "GetAttachmentOfEarningsByAttachmentOfEarningsId",
"parameters": [
{
"$ref": "#/components/parameters/attachmentOfEarningsId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/attachmentOfEarnings"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Attachment of earnings"
],
"description": "__Activity name :__ PutAttachmentOfEarningsByAttachmentOfEarningsId\n\nUpdate the details of a single attachment of earnings record\n\n__Metadata :__ Possible values for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the URL\n",
"summary": "Edit the details of an attachment of earnings record",
"operationId": "PutAttachmentOfEarningsByAttachmentOfEarningsId",
"parameters": [
{
"$ref": "#/components/parameters/attachmentOfEarningsId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/attachmentOfEarnings"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/attachmentOfEarnings"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Attachment of earnings"
],
"description": "__Activity name :__ DeleteAttachmentOfEarningsByAttachmentOfEarningsId\n\nDelete an existing attachment of earnings record\n",
"summary": "Delete an attachment of earnings record",
"operationId": "DeleteAttachmentOfEarningsByAttachmentOfEarningsId",
"parameters": [
{
"$ref": "#/components/parameters/attachmentOfEarningsId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/protectedearnings": {
"get": {
"tags": [
"Protected earnings"
],
"description": "__Activity name :__ GetProtectedEarningsByEmploymentId\n\nGet a list of protected earnings records\n",
"summary": "Get a list of protected earnings records",
"operationId": "GetProtectedEarningsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/protectedearnings"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Protected earnings"
],
"description": "__Activity name :__ PostProtectedEarningsByEmploymentId\n\nCreate a new protected earnings record for an employment.\n\n__Metadata :__ There is no metadata for this resource\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.\n",
"summary": "Create a new protected earnings record",
"operationId": "PostProtectedEarningsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"applicationjson;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/protectedearnings"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/protectedearnings"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/protectedearnings/{protectedEarningsId}": {
"get": {
"tags": [
"Protected earnings"
],
"description": "__Activity name :__ GetProtectedEarningsByProtectedEarningsId\n\nGet the details of an protected earnings record\n",
"summary": "Get the details of an protected earnings record",
"operationId": "GetProtectedEarningsByProtectedEarningsId",
"parameters": [
{
"$ref": "#/components/parameters/protectedEarningsId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/protectedearnings"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Protected earnings"
],
"description": "__Activity name :__ PutProtectedEarningsByProtectedEarningsId\n\nUpdate the details of a single protected earnings record\n\n__Metadata :__ There is no metadata for this resource\n",
"summary": "Edit the details of an protected earnings record",
"operationId": "PutProtectedEarningsByProtectedEarningsId",
"parameters": [
{
"$ref": "#/components/parameters/protectedEarningsId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/protectedearnings"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/protectedearnings"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Protected earnings"
],
"description": "__Activity name :__ DeleteProtectedEarningsByProtectedEarningsId\n\nDelete an existing protected earnings record\n",
"summary": "Delete an protected earnings record",
"operationId": "DeleteProtectedEarningsByProtectedEarningsId",
"parameters": [
{
"$ref": "#/components/parameters/protectedEarningsId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/fiscalproperties": {
"get": {
"tags": [
"Fiscal properties"
],
"description": "__Activity name:__ GetFiscalPropertiesByEmploymentId
Get the list of fiscal properties for an employment
\n",
"summary": "List of fiscal properties for an employment",
"operationId": "GetFiscalPropertiesByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2027-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fiscal_1-1-2027"
}
}
}
}
]
}
},
"application/json;version=2024-01-29": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fiscal-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Fiscal properties"
],
"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.
\n",
"summary": "Create a fiscal record for an employment",
"operationId": "PostFiscalPropertiesByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Fiscal properties record to add to the employment.",
"required": true,
"content": {
"application/json;version=2027-01-01": {
"schema": {
"$ref": "#/components/schemas/fiscal_1-1-2027"
}
},
"application/json;version=2024-01-29": {
"schema": {
"$ref": "#/components/schemas/fiscal-2"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2027-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/fiscal_1-1-2027"
}
}
}
]
}
},
"application/json;version=2024-01-29": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/fiscal-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/fiscalproperties/{fiscalPropertiesId}": {
"get": {
"tags": [
"Fiscal properties"
],
"description": "__Activity name:__ GetFiscalPropertiesByFiscalPropertiesId\n\nGet the details of fiscal\n",
"summary": "Details of a fiscal record",
"operationId": "GetFiscalPropertiesByFiscalPropertiesId",
"parameters": [
{
"$ref": "#/components/parameters/fiscalPropertiesId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2027-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/fiscal_1-1-2027"
}
}
}
]
}
},
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/fiscal-2"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Fiscal properties"
],
"description": "__Activity name:__ PutFiscalPropertiesByFiscalPropertiesId\n\nEdit the details for a fiscal properties record\n\nPossible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n",
"summary": "Edit the details of a fiscal record",
"operationId": "PutFiscalPropertiesByFiscalPropertiesId",
"parameters": [
{
"$ref": "#/components/parameters/fiscalPropertiesId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Fiscal to edit.",
"required": true,
"content": {
"application/json;version=2027-01-01": {
"schema": {
"$ref": "#/components/schemas/fiscal_1-1-2027"
}
},
"application/json;version=2024-01-29": {
"schema": {
"$ref": "#/components/schemas/fiscal-2"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2027-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/fiscal_1-1-2027"
}
}
}
]
}
},
"application/json;version=2024-01-29": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/fiscal-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Fiscal properties"
],
"description": "__Activity name:__ DeleteFiscalPropertiesByFiscalPropertiesId\n\nDelete a fiscal properties record for the employment\n",
"summary": "Delete a specific fiscal properties record",
"operationId": "DeleteFiscalPropertiesByFiscalPropertiesId",
"parameters": [
{
"$ref": "#/components/parameters/fiscalPropertiesId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/employees/employments/calculatedannualsalary": {
"get": {
"tags": [
"Fiscal properties"
],
"description": "__Activity name:__ GetCalculatedAnnualSalaryByPayrollAdministrationId
Get calculated values for the annual salary for employments within a payroll administration. Only eligable employments are included in the result.
\n",
"summary": "Calculate AnnualSalary",
"operationId": "GetCalculatedAnnualSalaryByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/calculatedAnnualSalary"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/fiscalproperties": {
"post": {
"tags": [
"Collective fiscal properties"
],
"description": "__Activity name :__ PostCollectiveFiscalPropertiesByEmployerId\n\nCreate new fiscal properties records for multiple employments of an employer\n",
"summary": "Create fiscal properties for multiple employments",
"operationId": "PostCollectiveFiscalPropertiesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Fiscal properties to add.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fiscalPropertiesCollective"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/fiscalcompanycars": {
"get": {
"tags": [
"Fiscal company car"
],
"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'
\n",
"summary": "List of fiscal company cars for an employment",
"operationId": "GetFiscalCompanyCarsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fiscalCompanyCar"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Fiscal company car"
],
"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.
\n",
"summary": "Create a fiscal company car record for an employment",
"operationId": "PostFiscalCompanyCarByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Fiscal Company Car record to add to the employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/fiscalCompanyCar"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/fiscalCompanyCar"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/fiscalcompanycars/{fiscalCompanyCarId}": {
"get": {
"tags": [
"Fiscal company car"
],
"description": "__Activity name:__ GetFiscalCompanyCarByFiscalCompanyCarId\n\n\n Get the details of fiscal company car \n\n\n Please note this resource is related for the registration of the company car for tax purposes.\n This is NOT directly related to the registration of the company car(s) related to the HRM-module Verstrekking\n",
"summary": "Details of a fiscal company car record",
"operationId": "GetFiscalCompanyCarByFiscalCompanyCarId",
"parameters": [
{
"$ref": "#/components/parameters/fiscalCompanyCarId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/fiscalCompanyCar"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Fiscal company car"
],
"description": "__Activity name:__ PutFiscalCompanyCarByFiscalCompanyCarId\n\n\n Edit the details for a fiscal company car record.\n\n\n Please note this resource is related for the registration of the company car for tax purposes.\n This is NOT directly related to the registration of the company car(s) related to the HRM-module Verstrekking\n\n\n __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n",
"summary": "Edit the details of a fiscal company car record",
"operationId": "PutFiscalCompanyCarByFiscalCompanyCarId",
"parameters": [
{
"$ref": "#/components/parameters/fiscalCompanyCarId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Company Car to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/fiscalCompanyCar"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/fiscalCompanyCar"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Fiscal company car"
],
"description": "__Activity name:__ DeleteFiscalCompanyCarByFiscalCompanyCarId\n\nDelete a fiscal company car record for the employment\n\nPlease 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\n",
"summary": "Delete a specific fiscal company car record",
"operationId": "DeleteFiscalCompanyCarByFiscalCompanyCarId",
"parameters": [
{
"$ref": "#/components/parameters/fiscalCompanyCarId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/import/fiscalcompanycars": {
"post": {
"tags": [
"Fiscal company car import"
],
"description": "__Activity name :__ PostFiscalCompanyCarImportDataByPayrollAdministrationId\n\n\n\nImports a csv file containing fiscal company car records.\n",
"summary": "Import fiscal company cars via a csv file",
"operationId": "PostFiscalCompanyCarImportDataByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "csv file to be uploaded.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/importFile"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"413": {
"$ref": "#/components/responses/requestEntityTooLarge"
},
"415": {
"$ref": "#/components/responses/unsupportedMediaType"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/companycars": {
"get": {
"tags": [
"Company car"
],
"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.
\n",
"summary": "List of company cars for an employment",
"operationId": "GetCompanyCarsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/companyCar"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Company car"
],
"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.
\n",
"summary": "Create a company car record for an employment",
"operationId": "PostCompanyCarByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Company Car record to add to the employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/companyCar"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/companyCar"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/companycars/{companyCarId}": {
"get": {
"tags": [
"Company car"
],
"description": "__Activity name:__ GetCompanyCarByCompanyCarId\n\n\n Get the details of a company car \n\n\nPlease 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.\n",
"summary": "Details of a company car record",
"operationId": "GetCompanyCarByCompanyCarId",
"parameters": [
{
"$ref": "#/components/parameters/companyCarId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/companyCar"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Company car"
],
"description": "__Activity name:__ PutCompanyCarByCompanyCarId\n\n\n Edit the details for a company car record.\n\n\nPlease 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.\n\n\n __Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n",
"summary": "Edit the details of a company car record",
"operationId": "PutCompanyCarByCompanyCarId",
"parameters": [
{
"$ref": "#/components/parameters/companyCarId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Company Car to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/companyCar"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/companyCar"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Company car"
],
"description": "__Activity name:__ DeleteCompanyCarByCompanyCarId\n\nDelete a company car record for the employment\n\nPlease 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.\n",
"summary": "Delete a specific company car record",
"operationId": "DeleteCompanyCarByCompanyCarId",
"parameters": [
{
"$ref": "#/components/parameters/companyCarId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/rdwservices/additionaltaxliability": {
"get": {
"tags": [
"Fiscal company car"
],
"description": "__Activity name:__ GetAdditionalTaxliabilityByLicensePlateNumber\n\nThis 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.\n",
"summary": "Acquire the additional tax liability by the license plate number (company car)",
"operationId": "GetAdditionalTaxliabilityByLicensePlateNumber",
"parameters": [
{
"$ref": "#/components/parameters/licensePlateNumber"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/additionaltaxliability"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/employmentfunds": {
"get": {
"tags": [
"Employment funds"
],
"description": "__Activity name :__ GetEmploymentFundsByEmploymentId\n\nGet a list of the funds the employment partakes in.\n",
"summary": "List of funds the employment partakes in",
"operationId": "GetEmploymentFundsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2023-05-26": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fundtotal2023-05-26"
}
}
}
}
]
},
"examples": {
"example1": {
"$ref": "#/components/examples/zonderDeviationOfFixedValuesList2023-05-26"
},
"example2": {
"$ref": "#/components/examples/metDeviationZonderFixedValuesList2023-05-26"
},
"example3": {
"$ref": "#/components/examples/zonderDeviationMetFixedValuesList2023-05-26"
}
}
},
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fundTotal"
}
}
}
}
]
},
"examples": {
"example1": {
"$ref": "#/components/examples/zonderDeviationOfFixedValuesList"
},
"example2": {
"$ref": "#/components/examples/metDeviationZonderFixedValuesList"
},
"example3": {
"$ref": "#/components/examples/zonderDeviationMetFixedValuesList"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Employment funds"
],
"description": "__Activity name :__ PostEmploymentFundByEmploymentId\n\n__Metadata :__ Possible options for fields of the type \"metadata\" can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults\" to the POST URL.\n\nActivate a fund for an employment",
"summary": "Activate a fund for an employment",
"operationId": "PostEmploymentFundByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a fund for an employment.",
"required": true,
"content": {
"application/json;version=2023-05-26": {
"schema": {
"$ref": "#/components/schemas/fundtotal2023-05-26"
},
"examples": {
"example1": {
"$ref": "#/components/examples/postZonderDeviationOfFixedValues2023-05-26"
},
"example2": {
"$ref": "#/components/examples/postMetDeviationZonderFixedValues2023-05-26"
},
"example3": {
"$ref": "#/components/examples/postZonderDeviationMetFixedValues2023-05-26"
}
}
},
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/fundTotal"
},
"examples": {
"example1": {
"$ref": "#/components/examples/postZonderDeviationOfFixedValues"
},
"example2": {
"$ref": "#/components/examples/postMetDeviationZonderFixedValues"
},
"example3": {
"$ref": "#/components/examples/postZonderDeviationMetFixedValues"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2023-05-26": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fundtotal2023-05-26"
}
}
}
}
]
},
"examples": {
"example1": {
"$ref": "#/components/examples/zonderDeviationOfFixedValuesDetail2023-05-26"
},
"example2": {
"$ref": "#/components/examples/metDeviationZonderFixedValuesDetail2023-05-26"
},
"example3": {
"$ref": "#/components/examples/zonderDeviationMetFixedValuesDetail2023-05-26"
}
}
},
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/fundTotal"
}
}
}
]
},
"examples": {
"example1": {
"$ref": "#/components/examples/zonderDeviationOfFixedValuesDetail"
},
"example2": {
"$ref": "#/components/examples/metDeviationZonderFixedValuesDetail"
},
"example3": {
"$ref": "#/components/examples/zonderDeviationMetFixedValuesDetail"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/employmentfunds/{employmentFundId}": {
"get": {
"tags": [
"Employment funds"
],
"description": "__Activity name :__ GetEmploymentFundByEmploymentFundId\n\nGet the details of an employment fund\n",
"summary": "Details of an employment fund",
"operationId": "GetEmploymentFundByEmploymentFundId",
"parameters": [
{
"$ref": "#/components/parameters/employmentFundId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2023-05-26": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fundtotal2023-05-26"
}
}
}
}
]
},
"examples": {
"example1": {
"$ref": "#/components/examples/zonderDeviationOfFixedValuesDetail2023-05-26"
},
"example2": {
"$ref": "#/components/examples/metDeviationZonderFixedValuesDetail2023-05-26"
},
"example3": {
"$ref": "#/components/examples/zonderDeviationMetFixedValuesDetail2023-05-26"
}
}
},
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fundTotal"
}
}
}
}
]
},
"examples": {
"example1": {
"$ref": "#/components/examples/zonderDeviationOfFixedValuesDetail"
},
"example2": {
"$ref": "#/components/examples/metDeviationZonderFixedValuesDetail"
},
"example3": {
"$ref": "#/components/examples/zonderDeviationMetFixedValuesDetail"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Employment funds"
],
"description": "__Activity name :__ PutEmploymentFundByEmploymentFundId\n\n__Metadata :__ Possible options for fields of the type \"metadata\" can be acquired (GET) by adding `/metadata` to the PUT URL.\n",
"summary": "Edit a employment fund record",
"operationId": "PutEmploymentFundByEmploymentFundId",
"parameters": [
{
"$ref": "#/components/parameters/employmentFundId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2023-05-26": {
"schema": {
"$ref": "#/components/schemas/fundReadOnlyForPut2023-05-26"
},
"examples": {
"example1": {
"$ref": "#/components/examples/putZonderDeviationOfFixedValues2023-05-26"
},
"example2": {
"$ref": "#/components/examples/putMetDeviationZonderFixedValues2023-05-26"
},
"example3": {
"$ref": "#/components/examples/putZonderDeviationMetFixedValues2023-05-26"
}
}
},
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/fundReadOnlyForPut"
},
"examples": {
"example1": {
"$ref": "#/components/examples/putZonderDeviationOfFixedValues"
},
"example2": {
"$ref": "#/components/examples/putMetDeviationZonderFixedValues"
},
"example3": {
"$ref": "#/components/examples/putZonderDeviationMetFixedValues"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2023-05-26": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fundtotal2023-05-26"
}
}
}
}
]
},
"examples": {
"example1": {
"$ref": "#/components/examples/zonderDeviationOfFixedValuesDetail2023-05-26"
},
"example2": {
"$ref": "#/components/examples/metDeviationZonderFixedValuesDetail2023-05-26"
},
"example3": {
"$ref": "#/components/examples/zonderDeviationMetFixedValuesDetail2023-05-26"
}
}
},
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/fundTotal"
}
}
}
]
},
"examples": {
"example1": {
"$ref": "#/components/examples/zonderDeviationOfFixedValuesDetail"
},
"example2": {
"$ref": "#/components/examples/metDeviationZonderFixedValuesDetail"
},
"example3": {
"$ref": "#/components/examples/zonderDeviationMetFixedValuesDetail"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Employment funds"
],
"description": "__Activity name :__ DeleteEmploymentFundByEmploymentFundId\n\nDelete an existing employment fund record.\n",
"summary": "Delete a specific employment fund record",
"operationId": "DeleteEmploymentFundByEmploymentFundId",
"parameters": [
{
"$ref": "#/components/parameters/employmentFundId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/abpfunds": {
"get": {
"tags": [
"Abp funds"
],
"description": "__Activity name :__ GetAbpFundsByEmploymentId\n\nGet a list of the abp funds the employment partakes in.\n",
"summary": "List of abp funds the employment partakes in",
"operationId": "GetAbpFundsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fundTotal-2"
}
}
}
}
]
},
"examples": {
"example1": {
"$ref": "#/components/examples/zonderDeviationOfFixedValuesList"
},
"example2": {
"$ref": "#/components/examples/metDeviationZonderFixedValuesList"
},
"example3": {
"$ref": "#/components/examples/zonderDeviationMetFixedValuesList"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Abp funds"
],
"description": "__Activity name :__ PostAbpFundByEmploymentId\n\n__Metadata :__ Possible options for fields of the type \"metadata\" can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults\" to the POST URL.\n\nActivate an abp fund for an employment",
"summary": "Activate an abp fund for an employment",
"operationId": "PostAbpFundByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add an abp fund for an employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/fundTotal-2"
},
"examples": {
"example1": {
"$ref": "#/components/examples/postZonderDeviationOfFixedValues"
},
"example2": {
"$ref": "#/components/examples/postMetDeviationZonderFixedValues-2"
},
"example3": {
"$ref": "#/components/examples/postZonderDeviationMetFixedValues"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/fundTotal-2"
}
}
}
]
},
"examples": {
"example1": {
"$ref": "#/components/examples/zonderDeviationOfFixedValuesDetail"
},
"example2": {
"$ref": "#/components/examples/metDeviationZonderFixedValuesDetail-2"
},
"example3": {
"$ref": "#/components/examples/zonderDeviationMetFixedValuesDetail"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/abpfunds/{abpFundId}": {
"get": {
"tags": [
"Abp funds"
],
"description": "__Activity name :__ GetAbpFundByAbpFundId\n\nGet the details of an abp fund\n",
"summary": "Details of an abp fund",
"operationId": "GetAbpFundByAbpFundId",
"parameters": [
{
"$ref": "#/components/parameters/abpFundId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fundTotal-2"
}
}
}
}
]
},
"examples": {
"example1": {
"$ref": "#/components/examples/zonderDeviationOfFixedValuesDetail"
},
"example2": {
"$ref": "#/components/examples/metDeviationZonderFixedValuesDetail-2"
},
"example3": {
"$ref": "#/components/examples/zonderDeviationMetFixedValuesDetail"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Abp funds"
],
"description": "__Activity name :__ PutAbpFundByAbpFundId\n\n__Metadata :__ Possible options for fields of the type \"metadata\" can be acquired (GET) by adding `/metadata` to the PUT URL.\n",
"summary": "Edit a abp fund record",
"operationId": "PutAbpFundByAbpFundId",
"parameters": [
{
"$ref": "#/components/parameters/abpFundId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/fundReadOnlyForPut-2"
},
"examples": {
"example1": {
"$ref": "#/components/examples/putZonderDeviationOfFixedValues"
},
"example2": {
"$ref": "#/components/examples/putMetDeviationZonderFixedValues-2"
},
"example3": {
"$ref": "#/components/examples/putZonderDeviationMetFixedValues"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/fundTotal-2"
}
}
}
]
},
"examples": {
"example1": {
"$ref": "#/components/examples/zonderDeviationOfFixedValuesDetail"
},
"example2": {
"$ref": "#/components/examples/metDeviationZonderFixedValuesDetail-2"
},
"example3": {
"$ref": "#/components/examples/zonderDeviationMetFixedValuesDetail"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Abp funds"
],
"description": "__Activity name :__ DeleteAbpFundByAbpFundId\n\nDelete an existing abp fund record.\n",
"summary": "Delete a specific abp fund record",
"operationId": "DeleteAbpFundByAbpFundId",
"parameters": [
{
"$ref": "#/components/parameters/abpFundId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/employmentfunds": {
"post": {
"tags": [
"Collective employment funds"
],
"description": "__Activity name :__ PostCollectiveEmploymentFundsByEmployerId\n\nCreate new employment fund records for multiple employments of an employer\n",
"summary": "Create employment funds for multiple employments",
"operationId": "PostCollectiveEmploymentFundsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Employmentfunds to add.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employmentFundsCollectivePost"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Collective employment funds"
],
"description": "__Activity name :__ PatchCollectiveEmploymentFundsByEmployerId\n\nSet the employment fund enddate for multiple employments of an employer\n",
"summary": "Set employment funds enddate for multiple employments",
"operationId": "PatchCollectiveEmploymentFundsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Employmentfunds to change.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employmentFundsCollectivePatch"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/abpfunds": {
"post": {
"tags": [
"Collective abp funds"
],
"description": "__Activity name :__ PostCollectiveAbpFundsByEmployerId\n\nCreate new abp fund records for multiple employments of an employer\n",
"summary": "Create abp funds for multiple employments",
"operationId": "PostCollectiveAbpFundsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Abp funds to add.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/abpFundsCollectivePost"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Collective abp funds"
],
"description": "__Activity name :__ PatchCollectiveAbpFundsByEmployerId\n\nSet the abp fund enddate for multiple employments of an employer\n",
"summary": "Set abp funds enddate for multiple employments",
"operationId": "PatchCollectiveAbpFundsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Abp funds to change.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/abpFundsCollectivePatch"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/basesforemploymentfundcalculation": {
"get": {
"tags": [
"Base for employment fund calculation"
],
"description": "__Activity name :__ GetBasesForEmploymentFundCalculationByEmploymentId\n\nGet a list of the bases (money) that are used in employment fund calculations.\n",
"summary": "List of bases for employment fund calculations.",
"operationId": "GetBasesForEmploymentFundCalculationByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/basesForEmploymentFundCalculationGetPost"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Base for employment fund calculation"
],
"description": "__Activity name :__ PostBaseForEmploymentFundCalculationByEmploymentId\n\n__Metadata :__ Possible options for fields of the type \"metadata\" can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults\" to the POST URL.\n\nAdd a base for employment fund calculation.\n",
"summary": "Add a base for employment fund calculation",
"operationId": "PostBaseForEmploymentFundCalculationByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/basesForEmploymentFundCalculationGetPost"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/basesForEmploymentFundCalculationGetPost"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/basesforemploymentfundcalculation/{baseforemploymentfundcalculationId}": {
"get": {
"tags": [
"Base for employment fund calculation"
],
"description": "__Activity name :__ GetBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId\n\nGet the details of a base for employment fund calculations.\n",
"summary": "Details of an base for employment fund calculations",
"operationId": "GetBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId",
"parameters": [
{
"$ref": "#/components/parameters/baseforemploymentfundcalculationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/basesForEmploymentFundCalculationGetPost"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Base for employment fund calculation"
],
"description": "__Activity name :__ PutBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId\n\n__Metadata :__ Possible options for fields of the type \"metadata\" can be acquired (GET) by adding `/metadata` to the PUT URL.\n\nEdit the properties of a base for employment calculation\n",
"summary": "Change the properties of a base for employment fund calculation",
"operationId": "PutBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId",
"parameters": [
{
"$ref": "#/components/parameters/baseforemploymentfundcalculationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "to edit",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/basesForEmploymentFundCalculationPut"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/basesForEmploymentFundCalculationGetPost"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Base for employment fund calculation"
],
"description": "__Activity name :__ DeleteBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId\n\nDelete an existing base for employment fund calculation\n",
"summary": "Delete a specific record",
"operationId": "DeleteBaseForEmploymentFundCalculationByBaseForEmploymentFundCalculationId",
"parameters": [
{
"$ref": "#/components/parameters/baseforemploymentfundcalculationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/basesforemploymentfundcalculation": {
"post": {
"tags": [
"Collective bases for employment fund calculation"
],
"description": "__Activity name :__ PostCollectiveBasesForEmploymentFundCalculationByEmployerId\n\nAdd a base for employment fund calculation records to multiple employments in one request. The request will be processed as a collective action.\n\nThe user can edit the most recent values or add new values. The user cannot edit old records or insert records in between existing records.\n",
"summary": "Create bases for employment fund calculation for multiple employments",
"operationId": "PostCollectiveBasesForEmploymentFundCalculationByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Bases for employment fund calculation to add.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/basesForEmploymentFundCalculationCollectivePost"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/basesforcalculation": {
"get": {
"tags": [
"Base for calculation"
],
"description": "__Activity name :__ GetBasesForCalculationByEmploymentId\n\nGet a list of the bases (money) that are used as the base for certain calculations.\n",
"summary": "List of bases for calculations.",
"operationId": "GetBasesForCalculationByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/basesForCalculationGetPost"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Base for calculation"
],
"description": "__Activity name :__ PostBaseForCalculationByEmploymentId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults` to the POST URL.\n\nAdd a base for calculation record.\n",
"summary": "Add a base for calculation",
"operationId": "PostBaseForCalculationByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a base for calculation record.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/basesForCalculationGetPost"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/basesForCalculationGetPost"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/basesforcalculation/{baseforcalculationId}": {
"get": {
"tags": [
"Base for calculation"
],
"description": "__Activity name :__ GetBaseForCalculationByBaseForCalculationId\n\nGet the details of a base for calculation.\n",
"summary": "Details of an base for calculation",
"operationId": "GetBaseForCalculationByBaseForCalculationId",
"parameters": [
{
"$ref": "#/components/parameters/baseforcalculationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/basesForCalculationGetPost"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Base for calculation"
],
"description": "__Activity name :__ PutBaseForCalculationByBaseForCalculationId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n\nEdit the properties of a base for calculation\n",
"summary": "Change the properties of a base for calculation",
"operationId": "PutBaseForCalculationByBaseForCalculationId",
"parameters": [
{
"$ref": "#/components/parameters/baseforcalculationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "to edit",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/basesForCalculationPut"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/basesForCalculationGetPost"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Base for calculation"
],
"description": "__Activity name :__ DeleteBaseForCalculationByBaseForCalculationId\n\nDelete an existing base for calculation\n",
"summary": "Delete a specific record",
"operationId": "DeleteBaseForCalculationByBaseForCalculationId",
"parameters": [
{
"$ref": "#/components/parameters/baseforcalculationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/basesforcalculation": {
"post": {
"tags": [
"Collective bases for calculation"
],
"description": "__Activity name :__ PostCollectiveBasesForCalculationByEmployerId\n\nCreate new bases for calculations for multiple employments of an employer\n",
"summary": "Create bases for calculation for multiple employments",
"operationId": "PostCollectiveBasesForCalculationByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Stuff to add.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/basesForCalculationCollectivePost"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Collective bases for calculation"
],
"description": "__Activity name :__ PatchCollectiveBasesForCalculationByEmployerId\n\nSet the base for calculation enddate for multiple employments of an employer\n",
"summary": "Set base for calculation enddate for multiple employments",
"operationId": "PatchCollectiveBasesForCalculationByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Stuff to change.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/basesForCalculationCollectivePatch"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/deviatingawfcontributions": {
"get": {
"tags": [
"Deviating AWF Contribution"
],
"description": "__Activity name:__ GetDeviatingAwfContributionsByEmploymentId\nGet the list of Deviating AWF contributions records for an employment\n",
"summary": "List of Deviating AWF contributions records for an employment",
"operationId": "GetDeviatingAwfContributionByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/deviatingAwfcontributions"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Deviating AWF Contribution"
],
"description": "__Activity name:__ PostDeviatingAwfContributionByEmploymentId\nCreate a Deviating AWF contributions record for an employment\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.\n\n__Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.\n",
"summary": "Create a Deviating AWF contributions record for an employment",
"operationId": "PostDeviatingAwfContributionByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Deviating AWF Contribution record to add to the employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/deviatingAwfcontributions"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/deviatingAwfcontributions"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/deviatingawfcontributions/{deviatingAwfContributionId}": {
"get": {
"tags": [
"Deviating AWF Contribution"
],
"description": "__Activity name:__ GetDeviatingAwfContributionByDeviatingAwfContributionId\n\nGet the details of a Deviating AWF contributions record\n",
"summary": "Details of a Deviating AWF contributions record",
"operationId": "GetDeviatingAwfContributionByDeviatingAwfContributionId",
"parameters": [
{
"$ref": "#/components/parameters/deviatingAwfContributionId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/deviatingAwfcontributions"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Deviating AWF Contribution"
],
"description": "__Activity name:__ PutDeviatingAwfContributionByDeviatingAwfContributionId\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.\n\nEdit the details for a Deviating AWF contribution record\n",
"summary": "Edit the details of a Deviating AWF contributions record",
"operationId": "PutDeviatingAwfContributionByDeviatingAwfContributionId",
"parameters": [
{
"$ref": "#/components/parameters/deviatingAwfContributionId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Deviating AWF Contribution record to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/deviatingAwfcontributions"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/deviatingAwfcontributions"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Deviating AWF Contribution"
],
"description": "__Activity name:__ DeleteDeviatingAwfContributionByDeviatingAwfContributionId\n\nDelete a Deviating AWF contribution record for the employment\n",
"summary": "Delete a specific Deviating AWF contributions record",
"operationId": "DeleteDeviatingAwfContributionByDeviatingAwfContributionId",
"parameters": [
{
"$ref": "#/components/parameters/deviatingAwfContributionId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/pensionbenefits": {
"get": {
"tags": [
"Pension benefit"
],
"description": "__Activity name :__ GetPensionBenefitsByEmploymentId\n\nGet a list of the pension benefits of the employment.\n\n__Note:__ Loket has different ways to register pension benefit. \n",
"summary": "List pension benefit",
"operationId": "GetPensionBenefitsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/pensionBenefits"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Pension benefit"
],
"description": "__Activity name :__ PostPensionBenefitByEmploymentId\n\n__Metadata :__ No metadata\n\n__Defaults :__ No default values\n",
"summary": "Add a pension benefit for an employment",
"operationId": "PostPensionBenefitByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a pension benefit",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/pensionBenefits"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/pensionBenefits"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/pensionbenefits/{pensionBenefitId}": {
"get": {
"tags": [
"Pension benefit"
],
"description": "__Activity name :__ GetPensionBenefitByPensionBenefitId\n\nGet the details of a pension benefit\n",
"summary": "Details of an pension benefit",
"operationId": "GetPensionBenefitByPensionBenefitId",
"parameters": [
{
"$ref": "#/components/parameters/pensionBenefitId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/pensionBenefits"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Pension benefit"
],
"description": "__Activity name :__ PutPensionBenefitByPensionBenefitId\n\n__Metadata :__ No metadata\n",
"summary": "Edit a pension benefit record",
"operationId": "PutPensionBenefitByPensionBenefitId",
"parameters": [
{
"$ref": "#/components/parameters/pensionBenefitId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/pensionBenefits"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/pensionBenefits"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Pension benefit"
],
"description": "__Activity name :__ DeletePensionBenefitByPensionBenefitId\n\nDelete an existing pension benefit record\n",
"summary": "Delete a pension benefit record",
"operationId": "DeletePensionBenefitByPensionBenefitId",
"parameters": [
{
"$ref": "#/components/parameters/pensionBenefitId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/deviatinghourlywages": {
"get": {
"tags": [
"Deviating hourly wage"
],
"description": "__Activity name :__ GetDeviatingHourlyWagesByEmploymentId\n\nGet a list of the deviating hourly wages of the employment.\n\n__Note:__ Loket has different ways to register deviating hourly wage. \n",
"summary": "List deviating hourly wage",
"operationId": "GetDeviatingHourlyWagesByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/deviatingHourlyWages"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Deviating hourly wage"
],
"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.\n",
"summary": "Add a deviating hourly wage for an employment",
"operationId": "PostDeviatingHourlyWageByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a deviating hourly wage",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/deviatingHourlyWages"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/deviatingHourlyWages"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/deviatinghourlywages/{deviatingHourlyWageId}": {
"get": {
"tags": [
"Deviating hourly wage"
],
"description": "__Activity name :__ GetDeviatingHourlyWageByDeviatingHourlyWageId\n\nGet the details of a deviating hourly wage\n",
"summary": "Details of an deviating hourly wage",
"operationId": "GetDeviatingHourlyWageByDeviatingHourlyWageId",
"parameters": [
{
"$ref": "#/components/parameters/deviatingHourlyWageId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/deviatingHourlyWages"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Deviating hourly wage"
],
"description": "__Activity name :__ PutDeviatingHourlyWageByDeviatingHourlyWageId\n\n__Metadata :__ No metadata as `payrollComponent` is read only in the PUT.\n",
"summary": "Edit a deviating hourly wage record",
"operationId": "PutDeviatingHourlyWageByDeviatingHourlyWageId",
"parameters": [
{
"$ref": "#/components/parameters/deviatingHourlyWageId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/deviatingHourlyWagesPayrollComponentReadonly"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/deviatingHourlyWages"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Deviating hourly wage"
],
"description": "__Activity name :__ DeleteDeviatingHourlyWageByDeviatingHourlyWageId\n\nDelete an existing deviating hourly wage record\n",
"summary": "Delete a deviating hourly wage record",
"operationId": "DeleteDeviatingHourlyWageByDeviatingHourlyWageId",
"parameters": [
{
"$ref": "#/components/parameters/deviatingHourlyWageId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/benefitsInKind": {
"get": {
"tags": [
"Benefit in kind"
],
"description": "__Activity name:__ GetBenefitsInKindByEmploymentId\nGet a list of the Benefits in kind of the employment.\n",
"summary": "List Benefits in kind",
"operationId": "GetBenefitsInKindByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/benefitInKind"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Benefit in kind"
],
"description": "__Activity name :__ PostBenefitInKindByEmploymentId\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.\n\n__Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.\n",
"summary": "Add a Benefit in kind for an employment",
"operationId": "PostBenefitInKindByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a benefit in kind",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/benefitInKind"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/benefitInKind"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/benefitsinkind/{benefitInKindId}": {
"get": {
"tags": [
"Benefit in kind"
],
"description": "__Activity name :__ GetBenefitInKindByBenefitInKindId\n\nGet the details of a benefit in kind\n",
"summary": "Details of an benefit in kind",
"operationId": "GetBenefitInKindByBenefitInKindId",
"parameters": [
{
"$ref": "#/components/parameters/benefitInKindId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/benefitInKind"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Benefit in kind"
],
"description": "__Activity name :__ PutBenefitInKindByBenefitInKindId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.\n",
"summary": "Edit a benefit in kind record",
"operationId": "PutBenefitInKindByBenefitInKindId",
"parameters": [
{
"$ref": "#/components/parameters/benefitInKindId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/benefitInKind"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/benefitInKind"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Benefit in kind"
],
"description": "__Activity name :__ DeleteBenefitInKindByBenefitInKindId\n\nDelete an existing benefit in kind record\n",
"summary": "Delete a benefit in kind record",
"operationId": "DeleteBenefitInKindByBenefitInKindId",
"parameters": [
{
"$ref": "#/components/parameters/benefitInKindId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/customnotifications": {
"get": {
"tags": [
"Custom notification"
],
"description": "__Activity name :__ GetCustomNotificationsByEmploymentId\nGet a list of the custom notifications of the employment.\n__Note:__ custom notifications are user defined for a specific employment.\n",
"summary": "List custom notification",
"operationId": "GetCustomNotificationsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customNotifications"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Custom notification"
],
"description": "__Activity name :__ PostCustomNotificationByEmploymentId\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.\n\n__Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.\n",
"summary": "Add a custom notification for an employment",
"operationId": "PostCustomNotificationByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a custom notification",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/customNotifications"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/customNotifications"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/customnotifications/{customNotificationId}": {
"get": {
"tags": [
"Custom notification"
],
"description": "__Activity name :__ GetCustomNotificationByCustomNotificationId\n\nGet the details of a custom notification\n",
"summary": "Details of a custom notification",
"operationId": "GetCustomNotificationByCustomNotificationId",
"parameters": [
{
"$ref": "#/components/parameters/customNotificationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customNotifications"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Custom notification"
],
"description": "__Activity name :__ PutCustomNotificationByCustomNotificationId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.\n",
"summary": "Edit a custom notification record",
"operationId": "PutCustomNotificationByCustomNotificationId",
"parameters": [
{
"$ref": "#/components/parameters/customNotificationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/customNotifications"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/customNotifications"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Custom notification"
],
"description": "__Activity name :__ DeleteCustomNotificationByCustomNotificationId\n\nDelete an existing custom notification record\n",
"summary": "Delete a custom notification record",
"operationId": "DeleteCustomNotificationByCustomNotificationId",
"parameters": [
{
"$ref": "#/components/parameters/customNotificationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/customfields": {
"get": {
"tags": [
"Employment custom field"
],
"description": "__Activity name :__ GetEmploymentCustomFieldsByEmploymentId\n\nGet a list of the custom fields for an employment.\n\n__Note:__ custom fields are user defined at the employer level.\n",
"summary": "List employment custom fields for an employment",
"operationId": "GetEmploymentCustomFieldssByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employmentCustomField"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Employment custom field"
],
"description": "__Activity name :__ PostEmploymentCustomFieldByEmploymentId\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n",
"summary": "Add an employment custom field for an employment",
"operationId": "PostEmploymentCustomFieldByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a custom field",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employmentCustomFieldPost"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employmentCustomField"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/customfields/{employmentCustomFieldId}": {
"get": {
"tags": [
"Employment custom field"
],
"description": "__Activity name :__ GetEmploymentCustomFieldByEmploymentCustomFieldId\n\nGet the details of a custom field\n",
"summary": "Details of an employment custom field",
"operationId": "GetEmploymentCustomFieldByEmploymentCustomFieldId",
"parameters": [
{
"$ref": "#/components/parameters/employmentCustomFieldId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employmentCustomField"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Employment custom field"
],
"description": "__Activity name :__ PutEmploymentCustomFieldByEmploymentCustomFieldId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.\n",
"summary": "Edit an employment custom field record",
"operationId": "PutEmploymentCustomFieldByEmploymentCustomFieldId",
"parameters": [
{
"$ref": "#/components/parameters/employmentCustomFieldId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employmentCustomField"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employmentCustomField"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Employment custom field"
],
"description": "__Activity name :__ DeleteEmploymentCustomFieldByEmploymentCustomFieldId\n\nDelete an existing custom field record\n",
"summary": "Delete an employment custom field record",
"operationId": "DeleteEmploymentCustomFieldByEmploymentCustomFieldId",
"parameters": [
{
"$ref": "#/components/parameters/employmentCustomFieldId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/otherPayrollVariables": {
"get": {
"tags": [
"Other payroll variables"
],
"description": "__Activity name :__ GetOtherPayrollVariablesByEmploymentId\n\nGet 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\n",
"summary": "List of other payroll variables for an employment",
"operationId": "GetOtherPayrollVariablesByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/otherPayrollVariables-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Other payroll variables"
],
"description": "__Activity name :__ PostOtherPayrollVariablesByEmploymentId\n\nAdd other payroll variables for an employment.\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.\n",
"summary": "Add other payroll variables for an employment",
"operationId": "PostOtherPayrollVariablesByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add other payroll variables for an employment",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/otherPayrollVariables-2"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/otherPayrollVariables-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/otherPayrollVariables/{otherPayrollVariablesId}": {
"get": {
"tags": [
"Other payroll variables"
],
"description": "__Activity name :__ GetOtherPayrollVariablesByOtherPayrollVariablesId\n\nGet the details of other payroll variables for an employment\n",
"summary": "Details of other payroll variables for an employment",
"operationId": "GetOtherPayrollVariablesByOtherPayrollVariablesId",
"parameters": [
{
"$ref": "#/components/parameters/otherPayrollVariablesId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/otherPayrollVariables-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Other payroll variables"
],
"description": "__Activity name :__ PutOtherPayrollVariablesByOtherPayrollVariablesId\n\nChange the details of an other payroll variables record\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n",
"summary": "Change the details of an other payroll variables record",
"operationId": "PutOtherPayrollVariablesByOtherPayrollVariablesId",
"parameters": [
{
"$ref": "#/components/parameters/otherPayrollVariablesId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/otherPayrollVariables-2"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/otherPayrollVariables-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Other payroll variables"
],
"description": "__Activity name :__ DeleteOtherPayrollVariablesByOtherPayrollVariablesId\n\nDelete an existing other payroll variables record (for an employment)\n",
"summary": "Delete a specific other payroll variables record",
"operationId": "DeleteOtherPayrollVariablesByOtherPayrollVariablesId",
"parameters": [
{
"$ref": "#/components/parameters/otherPayrollVariablesId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/socialsecurityconfigurations": {
"get": {
"tags": [
"Social security"
],
"description": "__Activity name:__ GetSocialSecurityConfigurationsByEmploymentId
Get the list of social security configuration records for an employment
\n",
"summary": "List of social security records for an employment",
"operationId": "GetSocialSecurityConfigurationByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/socialSecurity-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Social security"
],
"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.
\n",
"summary": "Create a social security record for an employment",
"operationId": "PostSocialSecurityConfigurationByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Social security record to add to the employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/socialSecurity-2"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/socialSecurity-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/socialsecurityconfigurations/{socialSecurityConfigurationId}": {
"get": {
"tags": [
"Social security"
],
"description": "__Activity name:__ GetSocialSecurityConfigurationBySocialSecurityConfigurationId\n\nGet the details of a social security configuration record\n",
"summary": "Details of a social security record",
"operationId": "GetSocialSecurityConfigurationBySocialSecurityConfigurationId",
"parameters": [
{
"$ref": "#/components/parameters/socialSecurityConfigurationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/socialSecurity-2"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Social security"
],
"description": "__Activity name:__ PutSocialSecurityConfigurationBySocialSecurityConfigurationId\n\nEdit the details for a social security record\n",
"summary": "Edit the details of a social security record",
"operationId": "PutSocialSecurityConfigurationBySocialSecurityConfigurationId",
"parameters": [
{
"$ref": "#/components/parameters/socialSecurityConfigurationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Social security record to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/socialSecurity-2"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/socialSecurity-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Social security"
],
"description": "__Activity name:__ DeleteSocialSecurityConfigurationBySocialSecurityConfigurationId\n\nDelete a social security record for the employment\n",
"summary": "Delete a specific social security record",
"operationId": "DeleteSocialSecurityConfigurationBySocialSecurityConfigurationId",
"parameters": [
{
"$ref": "#/components/parameters/socialSecurityConfigurationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/socialsecuritybenefits": {
"get": {
"tags": [
"Social security benefits"
],
"description": "__Activity name:__ GetSocialSecurityBenefitsByEmploymentId
Get the list of social security benefits records for an employment
\n",
"summary": "List of social security benefits records for an employment",
"operationId": "GetSocialSecurityBenefitByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/socialSecurityBenefitsPostGet"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Social security benefits"
],
"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.
\n",
"summary": "Create a social security benefits record for an employment",
"operationId": "PostSocialSecurityBenefitByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Social security record to add to the employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/socialSecurityBenefitsPostGet"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/socialSecurityBenefitsPostGet"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/socialsecuritybenefits/{socialSecurityBenefitId}": {
"get": {
"tags": [
"Social security benefits"
],
"description": "__Activity name:__ GetSocialSecurityBenefitBySocialSecurityBenefitId\n\nGet the details of a social security benefits record\n",
"summary": "Details of a social security benefits record",
"operationId": "GetSocialSecurityBenefitBySocialSecurityBenefitId",
"parameters": [
{
"$ref": "#/components/parameters/socialSecurityBenefitId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/socialSecurityBenefitsPostGet"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Social security benefits"
],
"description": "__Activity name:__ PutSocialSecurityBenefitBySocialSecurityBenefitId\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n\nEdit the details for a social security record\n",
"summary": "Edit the details of a social security benefits record",
"operationId": "PutSocialSecurityBenefitBySocialSecurityBenefitId",
"parameters": [
{
"$ref": "#/components/parameters/socialSecurityBenefitId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Social security record to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/socialSecurityBenefitsPut"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/socialSecurityBenefitsPostGet"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Social security benefits"
],
"description": "__Activity name:__ DeleteSocialSecurityBenefitBySocialSecurityBenefitId\n\nDelete a social security record for the employment\n",
"summary": "Delete a specific social security benefits record",
"operationId": "DeleteSocialSecurityBenefitBySocialSecurityBenefitId",
"parameters": [
{
"$ref": "#/components/parameters/socialSecurityBenefitId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/healthcareinsuranceactconfigurations": {
"get": {
"tags": [
"Healthcare Insurance Act"
],
"description": "__Activity name:__ GetHealthcareInsuranceActConfigurationsByEmploymentId
Get the list of Healthcare Insurance Act configuration records for an employment
\n",
"summary": "List of Healthcare Insurance Act records for an employment",
"operationId": "GetHealthcareInsuranceActConfigurationByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/healthcareInsuranceActConfiguration"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Healthcare Insurance Act"
],
"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.
\n",
"summary": "Create a Healthcare Insurance Act record for an employment",
"operationId": "PostHealthcareInsuranceActConfigurationByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Healthcare Insurance Act record to add to the employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/healthcareInsuranceActConfiguration"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/healthcareInsuranceActConfiguration"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/healthcareinsuranceactconfigurations/{healthcareInsuranceActConfigurationId}": {
"get": {
"tags": [
"Healthcare Insurance Act"
],
"description": "__Activity name:__ GetHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId\n\nGet the details of a Healthcare Insurance Act configuration record\n",
"summary": "Details of a Healthcare Insurance Act record",
"operationId": "GetHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId",
"parameters": [
{
"$ref": "#/components/parameters/healthcareInsuranceActConfigurationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/healthcareInsuranceActConfiguration"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Healthcare Insurance Act"
],
"description": "__Activity name:__ PutHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId\n\nEdit the details for a Healthcare Insurance Act record\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n",
"summary": "Edit the details of a Healthcare Insurance Act record",
"operationId": "PutHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId",
"parameters": [
{
"$ref": "#/components/parameters/healthcareInsuranceActConfigurationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Healthcare Insurance Act record to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/healthcareInsuranceActConfiguration"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/healthcareInsuranceActConfiguration"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Healthcare Insurance Act"
],
"description": "__Activity name:__ DeleteHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId\n\nDelete a Healthcare Insurance Act record for the employment\n",
"summary": "Delete a specific Healthcare Insurance Act record",
"operationId": "DeleteHealthcareInsuranceActConfigurationByHealthcareInsuranceActConfigurationId",
"parameters": [
{
"$ref": "#/components/parameters/healthcareInsuranceActConfigurationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/wachtgeld": {
"get": {
"tags": [
"Wachtgeld"
],
"description": "__Activity name :__ GetWachtgeldByEmploymentId\n\nGet a list of wachtgeld of the employment.\n\n__Note:__ Wachtgeld, or redundancy pay, is an additional benefit that you receive on top of your unemployment benefit.\n",
"summary": "List wachtgeld",
"operationId": "GetWachtgeldByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/wachtgeld"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Wachtgeld"
],
"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.\n",
"summary": "Add a wachtgeld for an employment",
"operationId": "PostWachtgeldByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a wachtgeld",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/wachtgeld"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/wachtgeld"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/wachtgeld/{wachtgeldId}": {
"get": {
"tags": [
"Wachtgeld"
],
"description": "__Activity name :__ GetWachtgeldByWachtgeldId\n\nGet the details of a wachtgeld record\n",
"summary": "Details of wachtgeld",
"operationId": "GetWachtgeldByWachtgeldId",
"parameters": [
{
"$ref": "#/components/parameters/wachtgeldId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/wachtgeld"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Wachtgeld"
],
"description": "__Activity name :__ PutWachtgeldByWachtgeldId\n\n__Metadata :__ No metadata.\n",
"summary": "Edit a wachtgeld record",
"operationId": "PutWachtgeldByWachtgeldId",
"parameters": [
{
"$ref": "#/components/parameters/wachtgeldId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/wachtgeld"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/wachtgeld"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Wachtgeld"
],
"description": "__Activity name :__ DeleteWachtgeldByWachtgeldId\n\nDelete an existing wachtgeld record\n",
"summary": "Delete a wachtgeld record",
"operationId": "DeleteWachtgeldByWachtgeldId",
"parameters": [
{
"$ref": "#/components/parameters/wachtgeldId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/contacts": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetContactsByEmployerId
Get the list of Contacts for all employees of an employer
\n",
"summary": "List of Contacts for an employer",
"operationId": "GetContactsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/contacts"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/children": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetChildrenByEmployerId
Get the list of Children for all employees of an employer
\n",
"summary": "List of Children for an employer",
"operationId": "GetChildrenByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/children"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/citizenservicenumbers": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetCitizenServiceNumbersByEmployerId
Get the list of citizenServiceNumber for all employees of an employer
\n",
"summary": "List of citizenServiceNumber for an employer",
"operationId": "GetcitizenServiceNumbersByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/citizenServiceNumber-3"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/customfields": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetEmployeeCustomFieldsByEmployerId
Get the list of custom fields for all employees of an employer.
\n",
"summary": "List of employee custom fields for an employer",
"operationId": "GetEmployeeCustomFieldsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employeeCustomFields"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/partners": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualPartnersByEmployerId
Get the list of Actual partners for all employees of an employer
\n",
"summary": "List of Partners for an employer",
"operationId": "GetActualPartnersByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/actualPartners"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/customfields": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetEmploymentCustomFieldsByEmployerId
Get the list of custom fields for all employments of an employer.
\n",
"summary": "List of employment custom fields for an employer",
"operationId": "GetEmploymentCustomFieldsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employmentCustomFields"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/paymentinformationsepa": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetPaymentInformationSepaByEmployerId
Get the list of sepa paymentinformation for all employments of an employer.
\n",
"summary": "List of payment information for an employer",
"operationId": "GetPaymentInformationSepaByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/paymentInformationSepa"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/actualorganizationalentities": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualOrganizationalEntitiesByEmployerId
Get the list of actual organizational entities for an employer
\n",
"summary": "List of actual organizational entities for an employer",
"operationId": "GetActualOrganizationalEntitiesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/organizationalEntities"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/actualwages": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualWagesByEmployerId
Get the list of actual wages for an employer
\n",
"summary": "List of actual wages for an employer",
"operationId": "GetActualWagesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/includeHistoricAndFutureData"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/wages"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/actualworkinghours": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualWorkingHoursByEmployerId
Get the list of actual working hours for an employer
\n",
"summary": "List of actual working hours for an employer",
"operationId": "GetActualWorkingHoursByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/includeHistoricAndFutureData"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/workingHours-3"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualbenefitsanddeductions": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualBenefitsAndDeductionsByEmployerId
Get the list of actual benefitsanddeductions for an employer
\n",
"summary": "List of actual benefitsanddeductions for an employer",
"operationId": "GetActualBenefitsAndDeductionsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/includeHistoricAndFutureData"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/benefitsAndDeductions"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualemploymentfunds": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualEmploymentFundsByEmployerId
Get the list of actual employmentfunds for all employments of an employer.
\n",
"summary": "List of actual employmentfunds for an employer",
"operationId": "GetActualEmploymentFundsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employmentFunds-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualabpfunds": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualAbpFundsByEmployerId
Get the list of actual abpfunds for all employments of an employer.
\n",
"summary": "List of actual abpfunds for an employer",
"operationId": "GetActualAbpFundsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/abpFunds-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualfiscalproperties": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualFiscalPropertiesByEmployerId
Get the list of actual fiscal properties for all employments of an employer.
\n",
"summary": "List of actual fiscal properties for an employer",
"operationId": "GetActualFiscalPropertiesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2027-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fiscalProperties_1-1-2027"
}
}
}
}
]
}
},
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fiscalProperties"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualExtraterritorialCostReimbursementSchemes": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualExtraterritorialCostReimbursementSchemesByEmployerId
Get the list of actual extraterritorial cost reimbursement schemes for all employments of an employer.
\n",
"summary": "List of actual extraterritorial cost reimbursement schemes for an employer",
"operationId": "GetActualExtraterritorialCostReimbursementSchemesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2027-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/extraterritorialCostReimbursementSchemes"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualhealthcareinsuranceactconfigurations": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualHealthCareInsuranceActConfigurationsByEmployerId
Get the list of actual healthcare insurance act configurations for all employments of an employer.
\n",
"summary": "List of actual healthcare configurations for an employer",
"operationId": "GetActualHealthCareInsuranceActConfigurationsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/healthCareInsuranceActConfigurations"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualsocialsecurityconfigurations": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualSocialSecurityConfigurationsByEmployerId
Get the list of actual social security configurations for all employments of an employer.
\n",
"summary": "List of actual social security configurations for an employer",
"operationId": "GetActualSocialSecurityConfigurationsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/socialSecurityConfigurations"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualsocialsecuritybenefits": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualSocialSecurityBenefitsByEmployerId
Get the list of actual social security benefits for all employments of an employer.
\n",
"summary": "List of actual social security benefits for an employer",
"operationId": "GetActualSocialSecurityBenefitsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/socialSecurityBenefits-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualdeviatingawfcontributions": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualDeviatingAwfContributionsByEmployerId
Get the list of actual deviating awf contributions for all employments of an employer.
\n",
"summary": "List of actual awf contributions for an employer",
"operationId": "GetActualDeviatingAwfContributionsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/deviatingAwfContribution"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualbenefitsinkind": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualBenefitsInKindByEmployerId
Get the list of actual benefits in kind for all employments of an employer.
\n",
"summary": "List of actual benefits in kind for an employer",
"operationId": "GetActualBenefitsInKindByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/benefitsInKind"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualcompanycars": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualCompanyCarsByEmployerId
Get the list of actual company cars for all employments of an employer.
\n",
"summary": "List of actual company cars for an employer",
"operationId": "GetActualCompanyCarsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/companyCars"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualfiscalcompanycars": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualFiscalCompanyCarsByEmployerId
Get the list of actual fiscal company cars for all employments of an employer.
\n",
"summary": "List of actual fiscal company cars for an employer",
"operationId": "GetActualFiscalCompanyCarsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/includeHistoricAndFutureData"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fiscalCompanyCars"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualjournalallocations": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualJournalAllocationsByEmployerId
Get the list of actual journal allocations for all employments of an employer.
\n",
"summary": "List of actual journal allocations for an employer",
"operationId": "GetActualJournalAllocationsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/journalAllocations"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualbasesforcalculation": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualBasesForCalculationByEmployerId
Get the list of actual bases for calculation for all employments of an employer.
\n",
"summary": "List of actual bases for calculation for an employer",
"operationId": "GetActualBasesForCalculationByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/basesForCalculation"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualotherpayrollvariables": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualOtherPayrollVariablesByEmployerId
Get the list of actual other payrollvariables for all employments of an employer.
\n",
"summary": "List of actual other payrollvariables for an employer",
"operationId": "GetActualOtherPayrollVariablesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/otherPayrollVariables-4"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualpaymentinformationnonsepa": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualPaymentInformationNonSepaByEmployerId
Get the list of actual payment information non sepa records for all employments of an employer.
\n",
"summary": "List of actual payment information non sepa for an employer",
"operationId": "GetActualPaymentInformationNonSepaByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/paymentInformationNonSepa-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualbasesforemploymentfundcalculation": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualBasesForEmploymentFundCalculationByEmployerId
Get the list of actual bases for employment fund calculation for all employments of an employer.
\n",
"summary": "List of actual bases for employment fund calculation for an employer",
"operationId": "GetActualBasesForEmploymentFundCalculationByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/basesForEmploymentFundCalculation"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualpensionbenefits": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualPensionBenefitsByEmployerId
Get the list of actual pension benefits for all employments of an employer.
\n",
"summary": "List of actual pension benefits for an employer",
"operationId": "GetActualPensionBenefitsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/pensionBenefits-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualdeviatinghourlywages": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualDeviatingHourlyWagesByEmployerId
Get the list of actual deviating hourly wage for all employments of an employer.
\n",
"summary": "List of actual deviating hourly wage for an employer",
"operationId": "GetActualDeviatingHourlyWagesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/deviatingHourlyWage"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/actualcostperhour": {
"get": {
"tags": [
"Actuals"
],
"description": "__Activity name:__ GetActualCostPerHourByEmployerId
Get the list of actual cost per hour for all employments of an employer.
\n",
"summary": "List of actual cost per hour for an employer",
"operationId": "GetActualCostPerHourByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate"
},
{
"$ref": "#/components/parameters/includeEstimation"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/costperhour"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/achmeainsurancecontracts": {
"get": {
"tags": [
"Achmea"
],
"description": "__Activity name :__ GetAchmeaInsuranceContractsByUserId\nGet a list of all Achmea insurance contracts accessible to the current user\n",
"summary": "list of insurance contracts",
"operationId": "GetAchmeaInsuranceContractsByUserId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/insuranceContract"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/achmeainsurancecontracts/{achmeaInsuranceContractId}/insuredwagecalculationpercentages": {
"get": {
"tags": [
"Achmea"
],
"description": "__Activity name :__ GetWagePercentagesByAchmeaInsuranceContractId\n\nGet a list of all wage percentages (year-end bonus and holiday allowance percentages) for an Achmea insurance contract.\n",
"summary": "list of wage percentages for an insurance contract",
"operationId": "GetWagePercentagesByAchmeaInsuranceContractId",
"parameters": [
{
"$ref": "#/components/parameters/achmeaInsuranceContractId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/wagePercentages"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/benifyurl": {
"get": {
"tags": [
"Employee benefits"
],
"description": "__Activity name :__ GetBenifyUrlByEmployeeId\n\nGet a URL to access the Benify portal for an employee.\n",
"summary": "Get Benify URL for an employee",
"operationId": "GetBenifyUrlByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/benifyObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/users/yourcampus": {
"get": {
"tags": [
"Employee benefits"
],
"description": "__Activity name :__ GetYourcampusUrlByUserId\n\nGet a URL to access the Yourcampus portal for a user\n",
"summary": "Get Yourcampus URL for a user",
"operationId": "GetYourcampusUrlByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/yourcampusObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/qwoater/employers": {
"get": {
"tags": [
"Qwoater"
],
"description": "__Activity name :__ GetQwoaterEmployersByUser\n\nReturns a list of employerIds that have at least one Qwoater product enabled with the corresponding providerId and lastModifiedVersionNumber for the employer.\n\n**What does the 'last modified' version number reflect**\n\nThe sequence number of an employer is a sequential number that reflects whether any changes have occurred in any of its UNDERLYING employments.\n\nMore 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)\n\nThe scope of this predefined set is to represent 'static' employment data (vaste gegevens), and thus excludes payroll period data (variabele gegevens).\n\n**When to use**\n\nThis 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.\n\n**How to use**\n\nWith 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).\nConsequently, 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`.\n\n*Recommended usage*\n\n* Perform your regular synchronization of static employment data\n* Store the highest version number, for which you have now processed all changes. (You may use the following parameter to do this `?orderBy=-lastModifiedVersionNumber` )\n* Next time you want to perform synchronization. Call this endpoint with parameter `?filter=lastModifiedVersionNumber gt {{YourVersionNumber}}`\n* 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)\n",
"summary": "List of employers using Qwoater",
"operationId": "GetQwoaterEmployersByUser",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/qwoaterObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/leavePolicies": {
"get": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ GetLeavePoliciesByEmployerId
Returns all the leave policies for the given employer.\n",
"summary": "List of all the leave policies",
"operationId": "GetLeavePoliciesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/leavePolicy"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ PostLeavePolicyByEmployerId\n\nAdd a leave policy\n",
"summary": "Create a leave policy",
"operationId": "PostLeavePolicyByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/leavePolicy"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/leavePolicy"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ PatchCopyLeavePolicyByEmployerId\n\nAdd a leave policy based on an existing leave policy at providerlevel. (Create a copy)\n",
"summary": "Create a leave policy based on an existing leave policy",
"operationId": "PatchCopyLeavePolicyByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/copyLeavePolicy"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/leavePolicyIdOnly"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/leavePolicies/{leavePolicyId}": {
"get": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ GetLeavePolicyByLeavePolicyId\n\nReturns one leave policy",
"summary": "A single leave policy",
"operationId": "GetLeavePolicyByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/leavePolicy"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ PutLeavePolicyByLeavePolicyId\n\nEdit the details of a leave policy\n",
"summary": "Edit the details of a leave policy",
"operationId": "PutLeavePolicyByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Leave policy to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/leavePolicy"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/leavePolicy"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ DeleteLeavePolicyByLeavePolicyId\n\nDelete a Leave policy\n",
"summary": "Delete a leave policy",
"operationId": "DeleteLeavePolicyByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/leavePolicies/{leavePolicyId}/agebasedleave": {
"get": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ GetAgeBasedLeaveByLeavePolicyId
Returns the age based leave for the given leave policy.\n",
"summary": "Age based leave",
"operationId": "GetAgeBasedLeaveByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ageBasedLeave"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ PostAgeBasedLeaveByLeavePolicyId\n\nAdd an age based leave \n",
"summary": "Create an age based leave record",
"operationId": "PostAgeBasedLeaveByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/ageBasedLeave"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ageBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/leavePolicies/agebasedleave/{ageBasedLeaveId}": {
"get": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ GetAgeBasedLeaveByAgeBasedLeaveId\n\nReturns one leave age based leave record",
"summary": "An age based leave record",
"operationId": "GetAgeBasedLeaveByAgeBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/ageBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ageBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ PutAgeBasedLeaveByAgeBasedLeaveId\n\nEdit the details of an age based leave record\n",
"summary": "Edit the details of an age based leave",
"operationId": "PutAgeBasedLeaveByAgeBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/ageBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "age based leave to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/ageBasedLeave"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ageBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ DeleteAgeBasedLeaveByAgeBasedLeaveId\n\nDelete an age based leave record\n",
"summary": "Delete an age based leave record",
"operationId": "DeleteAgeBasedLeaveByAgeBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/ageBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/leavePolicies/{leavePolicyId}/yearsofservicebasedleave": {
"get": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ GetYearsOfServiceBasedLeaveByLeavePolicyId
Returns the years of service based leave for the given leave policy.\n",
"summary": "years of service based leave",
"operationId": "GetYearsOfServiceBasedLeaveByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/yearsOfServiceBasedLeave"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ PostYearsOfServiceBasedLeaveByLeavePolicyId\n\nAdd a years of service based leave \n",
"summary": "Create a years of service based leave record",
"operationId": "PostYearsOfServiceBasedLeaveByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/yearsOfServiceBasedLeave"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/yearsOfServiceBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/leavePolicies/yearsofservicebasedleave/{yearsOfServiceBasedLeaveId}": {
"get": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ GetYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId\n\nReturns one leave years of service based leave record",
"summary": "A years of service based leave record",
"operationId": "GetYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/yearsOfServiceBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/yearsOfServiceBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ PutYearsOFServiceBasedLeaveByYearsOfServiceBasedLeaveId\n\nEdit the details of a years of service based leave record\n",
"summary": "Edit the details of a years of service based leave",
"operationId": "PutYearsOFServiceBasedLeaveByYearsOfServiceBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/yearsOfServiceBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "years of service based leave to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/yearsOfServiceBasedLeave"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/yearsOfServiceBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ DeleteYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId\n\nDelete an years of service based leave record\n",
"summary": "Delete an years of service based leave record",
"operationId": "DeleteYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/yearsOfServiceBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/leavePolicies/{leavePolicyId}/wagebasedleave": {
"get": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ GetWageBasedLeaveByLeavePolicyId
Returns the wage based leave for the given leave policy.\n",
"summary": "Wage based leave",
"operationId": "GetWageBasedLeaveByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/wageBasedLeave"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ PostWageBasedLeaveByLeavePolicyId\n\nAdd a wage based leave \n",
"summary": "Create a wage based leave record",
"operationId": "PostWageBasedLeaveByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/wageBasedLeave"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/wageBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/leavePolicies/wagebasedleave/{wageBasedLeaveId}": {
"get": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ GetWageBasedLeaveByAgeBasedLeaveId\n\nReturns one leave wage based leave record",
"summary": "A wage based leave record",
"operationId": "GetWageBasedLeaveByWageBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/wageBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/wageBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ PutWageBasedLeaveByWageBasedLeaveId\n\nEdit the details of a wage based leave record\n",
"summary": "Edit the details of a wage based leave",
"operationId": "PutWageBasedLeaveByWageBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/wageBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "wage based leave to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/wageBasedLeave"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/wageBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ DeleteWageBasedLeaveByWageBasedLeaveId\n\nDelete a wage based leave record\n",
"summary": "Delete a wage based leave record",
"operationId": "DeleteWageBasedLeaveByWageBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/wageBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/leavepolicies/{leavePolicyId}/employments": {
"get": {
"tags": [
"Leave policy and employment links"
],
"description": "__Activity name:__ GetEmploymentsByLeavePolicyId\nGet the list of employments that are linked for this leave policy.\nWhen a leave policy and an employment are linked, that means the employment will be provided with leave based on the policy.\n",
"summary": "Get list of linked employments for the leave policy",
"operationId": "GetEmploymentsByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/linkedEmployment-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Leave policy and employment links"
],
"description": "__Activity name:__ PatchEmploymentsByLeavePolicyId\nThis 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.\n",
"summary": "Create or delete multiple linked employments for the leave policy",
"operationId": "PatchEmploymentsByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "The request body contains an array of objects containing a `employment` and an `action` field.",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/linkedEmploymentsPatch"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/leavepolicies/{leavePolicyId}/employments/leave/accrual": {
"get": {
"tags": [
"Leave policy accrual"
],
"description": "__Activity name :__ GetLeavePolicyAccrualByLeavePolicyId
Returns the accrual for each leave type for all employments within an employer that have accrual for the given leavepolicy.\n",
"summary": "Leave accrual for employments of a leave policy",
"operationId": "GetLeavePolicyAccrualByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId-2"
},
{
"$ref": "#/components/parameters/year-2"
},
{
"$ref": "#/components/parameters/month"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/leavePolicyAccrual"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/leavepolicies/{leavePolicyId}/employments/{employmentId}/leave/accrual\"": {
"get": {
"tags": [
"Leave policy accrual"
],
"description": "__Activity name :__ GetLeavePolicyAccrualByLeavePolicyIdAndEmploymentId
Returns the accrual for each leave type, given a leavepolicy and year\n",
"summary": "Leave accrual for an employment",
"operationId": "GetLeavePolicyAccrualByLeavePolicyIdAndEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId-2"
},
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/year-2"
},
{
"$ref": "#/components/parameters/month"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/accrualMultiGetObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/leavepolicies/{leavePolicyId}/employments/leave/entitlement": {
"get": {
"tags": [
"Leave policy entitlement"
],
"description": "__Activity name :__ GetLeavePolicyEntitlementByLeavePolicyId
Returns the entitlement for each leave type.\n",
"summary": "Leave entitlement for employments of a leave policy",
"operationId": "GetLeavePolicyEntitlementByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId-2"
},
{
"$ref": "#/components/parameters/year-2"
},
{
"$ref": "#/components/parameters/month"
},
{
"$ref": "#/components/parameters/overridingEmploymentEndDate"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/entitlementMultiGetObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/leavepolicies/{leavePolicyId}/employments/{employmentId}/leave/entitlement\"": {
"get": {
"tags": [
"Leave policy entitlement"
],
"description": "__Activity name :__ GetLeavePolicyEntitlementByLeavePolicyIdAndEmploymentId
Returns the entitlement for each leave type, given a leavepolicy and year\n",
"summary": "Leave entitlement for an employment",
"operationId": "GetLeavePolicyEntitlementByLeavePolicyIdAndEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId-2"
},
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/year-2"
},
{
"$ref": "#/components/parameters/month"
},
{
"$ref": "#/components/parameters/overridingEmploymentEndDate"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/entitlementMultiGetObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/leave/entitlement": {
"patch": {
"tags": [
"Leave policy entitlement"
],
"description": "__Activity name :__ PatchCollectiveLeavePolicyEntitlementByEmployerId\n\nStarts a process that will calculate and apply the leave entitlement for a set of employments, given a leavepolicy and year.\n",
"summary": "Apply the entitlement for multiple employments",
"operationId": "PatchCollectiveLeavePolicyEntitlementByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/entitlementMultiPatchObject"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/leave/entitlement\"": {
"patch": {
"tags": [
"Leave policy entitlement"
],
"description": "__Activity name :__ PatchLeavePolicyEntitlementByEmploymentId\n\nStarts a process that will calculate and apply the leave entitlement for the employment, given a leavepolicy and year.\n",
"summary": "Apply the entitlement for an employment",
"operationId": "PatchLeavePolicyEntitlementByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/entitlementSinglePatchObject"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/leavePolicies": {
"get": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ GetProviderLeavePoliciesByProviderId
Returns all the leave policies for the given provider. These leave policies can be used to define a leave policy at employer level.\n",
"summary": "List of all the leave policies at provider level.",
"operationId": "GetProviderLeavePoliciesByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/leavePolicy"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ PostProviderLeavePolicyByProviderId\n\nAdd a leave policy\n",
"summary": "Create a leave policy",
"operationId": "PostProviderLeavePolicyByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/leavePolicy"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/leavePolicy"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/leavePolicies/{leavePolicyId}": {
"get": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ GetProviderLeavePolicyByLeavePolicyId\n\nReturns one leave policy",
"summary": "A single leave policy",
"operationId": "GetProviderLeavePolicyByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/leavePolicy"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ PutProviderLeavePolicyByLeavePolicyId\n\nEdit the details of a leave policy\n",
"summary": "Edit the details of a leave policy",
"operationId": "PutProviderLeavePolicyByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Leave policy to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/leavePolicy"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/leavePolicy"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ DeleteProviderLeavePolicyByLeavePolicyId\n\nDelete a Leave policy\n",
"summary": "Delete a leave policy",
"operationId": "DeleteProviderLeavePolicyByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/leavePolicies/{leavePolicyId}/agebasedleave": {
"get": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ GetProviderAgeBasedLeaveByLeavePolicyId
Returns the age based leave for the given leave policy at provider level.\n",
"summary": "Age based leave",
"operationId": "GetProviderAgeBasedLeaveByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ageBasedLeave"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ PostProviderAgeBasedLeaveByLeavePolicyId\n\nAdd an age based leave \n",
"summary": "Create an age based leave record",
"operationId": "PostProviderAgeBasedLeaveByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/ageBasedLeave"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ageBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/leavePolicies/agebasedleave/{ageBasedLeaveId}": {
"get": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ GetProviderAgeBasedLeaveByAgeBasedLeaveId\n\nReturns one leave age based leave record",
"summary": "An age based leave record",
"operationId": "GetProviderAgeBasedLeaveByAgeBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/ageBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ageBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ PutProviderAgeBasedLeaveByAgeBasedLeaveId\n\nEdit the details of an age based leave record\n",
"summary": "Edit the details of an age based leave",
"operationId": "PutProviderAgeBasedLeaveByAgeBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/ageBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "age based leave to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/ageBasedLeave"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ageBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ DeleteProviderAgeBasedLeaveByAgeBasedLeaveId\n\nDelete an age based leave record\n",
"summary": "Delete an age based leave record",
"operationId": "DeleteProviderAgeBasedLeaveByAgeBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/ageBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/leavePolicies/{leavePolicyId}/yearsofservicebasedleave": {
"get": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ GetProviderYearsOfServiceBasedLeaveByLeavePolicyId
Returns the years of service based leave for the given leave policy at providerlevel.\n",
"summary": "years of service based leave",
"operationId": "GetProviderYearsOfServiceBasedLeaveByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/yearsOfServiceBasedLeave"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ PostProviderYearsOfServiceBasedLeaveByLeavePolicyId\n\nAdd a years of service based leave \n",
"summary": "Create a years of service based leave record",
"operationId": "PostProviderYearsOfServiceBasedLeaveByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/yearsOfServiceBasedLeave"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/yearsOfServiceBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/leavePolicies/yearsofservicebasedleave/{yearsOfServiceBasedLeaveId}": {
"get": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ GetProviderYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId\n\nReturns one leave years of service based leave record",
"summary": "A years of service based leave record",
"operationId": "GetProviderYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/yearsOfServiceBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/yearsOfServiceBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ PutProviderYearsOFServiceBasedLeaveByYearsOfServiceBasedLeaveId\n\nEdit the details of a years of service based leave record\n",
"summary": "Edit the details of a years of service based leave",
"operationId": "PutProviderYearsOFServiceBasedLeaveByYearsOfServiceBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/yearsOfServiceBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "years of service based leave to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/yearsOfServiceBasedLeave"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/yearsOfServiceBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ DeleteProviderYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId\n\nDelete an years of service based leave record\n",
"summary": "Delete an years of service based leave record",
"operationId": "DeleteProviderYearsOfServiceBasedLeaveByYearsOfServiceBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/yearsOfServiceBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/leavePolicies/{leavePolicyId}/wagebasedleave": {
"get": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ GetProviderWageBasedLeaveByLeavePolicyId
Returns the wage based leave for the given leave policy at provider level.\n",
"summary": "Wage based leave",
"operationId": "GetProviderWageBasedLeaveByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/wageBasedLeave"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ PostProviderWageBasedLeaveByLeavePolicyId\n\nAdd a wage based leave \n",
"summary": "Create a wage based leave record",
"operationId": "PostProviderWageBasedLeaveByLeavePolicyId",
"parameters": [
{
"$ref": "#/components/parameters/leavePolicyId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/wageBasedLeave"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/wageBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/leavePolicies/agebasedleave/{wageBasedLeaveId}": {
"get": {
"tags": [
"Provider leave policy"
],
"description": "__Activity name :__ GetProviderWageBasedLeaveByAgeBasedLeaveId\n\nReturns one leave wage based leave record",
"summary": "A wage based leave record",
"operationId": "GetProviderWageBasedLeaveByWageBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/wageBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/wageBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ PutProviderWageBasedLeaveByWageBasedLeaveId\n\nEdit the details of a wage based leave record\n",
"summary": "Edit the details of a wage based leave",
"operationId": "PutProviderWageBasedLeaveByWageBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/wageBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "wage based leave to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/wageBasedLeave"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/wageBasedLeave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Leave policy"
],
"description": "__Activity name :__ DeleteProviderWageBasedLeaveByWageBasedLeaveId\n\nDelete a wage based leave record\n",
"summary": "Delete a wage based leave record",
"operationId": "DeleteProviderWageBasedLeaveByWageBasedLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/wageBasedLeaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/leavetypes": {
"get": {
"tags": [
"Leave types"
],
"description": "__Activity name :__ GetLeaveTypesByEmployerId\n\nGet a list of all leavetypes for the employer\n",
"summary": "List of leave types",
"operationId": "GetLeaveTypesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/leaveType-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/leavetypes/{leaveTypeId}": {
"get": {
"tags": [
"Leave types"
],
"description": "__Activity name:__ GetLeaveTypeByEmployerIdAndLeaveTypeId\n\nGet the details of a leave type\n",
"summary": "Details of a leave type",
"operationId": "GetLeaveTypeByEmployerIdAndLeaveTypeId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/leaveTypeId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/leaveType-2"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Leave types"
],
"description": "__Activity name:__ PutLeaveTypeByEmployerIdAndLeaveTypeId\n\nEdit the details for a leave type\n\n__Metadata :__ There is no metadata endpoint for this resource.\n",
"summary": "Edit the details of a leave type",
"operationId": "PutLeaveTypeByEmployerIdAndLeaveTypeId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/leaveTypeId"
}
],
"requestBody": {
"description": "Leave type to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/leaveType-2"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/leaveType-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/leaverequests": {
"get": {
"tags": [
"Leave request"
],
"summary": "List of leave requests for the employees of an employer",
"operationId": "GetLeaveRequestsByEmployer",
"description": "__Activity name :__ GetLeaveRequestsByEmployerId\n\nReturns a list of leave requests for the employments of the employer\n",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/leaveRequest"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/leaverequests": {
"patch": {
"tags": [
"Leave request"
],
"summary": "Change the status of leave requests",
"description": "__Activity name :__ PatchLeaveRequestsByLeaveRequestIds\n\nThis 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 successfully will not be returned in te response.\n\nThis endpoint can be used by provider, employer and employee users. Provider and employer users are able to accept, reject or reopen leave requests depending on the status of the request. Employee users are only able to revoke a submitted leave request.\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"operationId": "PatchLeaveRequestsByLeaveRequestIds",
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/leaveRequestPatch"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/leaverequests/currentlyAvailableUnits": {
"get": {
"tags": [
"Leave request"
],
"summary": "Currently available units for the given leaveRequestIds",
"description": "__Activity name :__ GetCurrentlyAvailableUnitsByLeaveRequestIds\n\nThis endpoint returns for the given set of leaveRequestIDs, the currentlyAvailableUnits for the leaveType of the leave request.\nAll leaveRequestIDs must be accessible by the user.\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/leaveRequestIds"
}
],
"operationId": "GetCurrentlyAvailableUnitsByLeaveRequestIds",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/currentlyAvailableUnitsLeaveRequest"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/leave": {
"get": {
"tags": [
"Leave"
],
"description": "__Activity name :__ GetLeaveByEmploymentId
Returns all the leave entries (both addition and subtraction) for the given employment.\n",
"summary": "List of all the leave entries",
"operationId": "GetLeaveByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/leave"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Leave"
],
"description": "__Activity name :__ PostLeaveByEmploymentId\n\nAdd a Leave record for an employment\n",
"summary": "Create a leave record for an employment",
"operationId": "PostLeaveByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/leave"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/leave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/leave/{leaveId}": {
"get": {
"tags": [
"Leave"
],
"description": "__Activity name :__ GetLeaveByLeaveId\n\nReturns one leave entry (either addition or subtraction).",
"summary": "A single leave entry",
"operationId": "GetLeaveByLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/leaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/leave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Leave"
],
"description": "__Activity name :__ PutLeaveByLeaveId\n\nEdit the details of a leave\n",
"summary": "Edit the details of a leave",
"operationId": "PutLeaveByLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/leaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Leave to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/leave"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/leave"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Leave"
],
"description": "__Activity name :__ DeleteLeaveByLeaveId\n\nDelete an existing Leave record\n",
"summary": "Delete a specific leave record",
"operationId": "DeleteLeaveByLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/leaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/leave/metadata": {
"get": {
"tags": [
"Leave"
],
"description": "__Activity name :__ GetLeaveMetadataByEmploymentId\n\nReturns the metadata values for all the metadata fields.\n",
"summary": "Get the values for the metadata fields",
"operationId": "GetLeaveMetadataByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageBrokenBusinessRule-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/metadata"
}
}
}
}
]
},
"examples": {
"metadata": {
"$ref": "#/components/examples/metadata"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/leave/defaults": {
"get": {
"tags": [
"Leave"
],
"description": "__Activity name :__ GetLeaveDefaultsByEmploymentId\n\nReturns the default values for all the fields. In case no default is present `null` will be returned.\n",
"summary": "Get the default values to be used when POSTing a new record",
"operationId": "GetLeaveDefaultsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageBrokenBusinessRule-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/leave"
}
}
}
}
]
},
"examples": {
"defaults": {
"$ref": "#/components/examples/defaults"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/leave/{leaveId}/metadata": {
"get": {
"tags": [
"Leave"
],
"description": "__Activity name :__ GetLeaveMetadataByLeaveId\n\nReturns the metadata values for all the metadata fields.\n",
"summary": "Get the values for the metadata fields",
"operationId": "GetLeaveMetadataByLeaveId",
"parameters": [
{
"$ref": "#/components/parameters/leaveId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageBrokenBusinessRule-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/metadata"
}
}
}
}
]
},
"examples": {
"metadata": {
"$ref": "#/components/examples/metadata"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/leave/proposedleavehours": {
"get": {
"tags": [
"Leave"
],
"description": "__Activity name :__ GetProposedLeaveHoursByEmploymentId\n\nReturns the numberOfHours (only in hours) calculated based on the employments working- hours/schedual \n\n__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.\n\nFurther 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\n",
"summary": "Get the proposed number of leave hours for an employment",
"operationId": "GetProposedLeaveHoursByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/startDate"
},
{
"$ref": "#/components/parameters/endDate"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/proposedLeaveHoursResponse"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/leave/proposedleavehours": {
"get": {
"tags": [
"Leave"
],
"description": "__Activity name :__ GetProposedLeaveHoursByEmployerId\n\nReturns the numberOfHours (only in hours) calculated based on the employments working- hours/schedual \n\n__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.\n\nFurther 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\n",
"summary": "Get the proposed number of leave hours for all employments of an employer",
"operationId": "GetProposedLeaveHoursByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/startDate"
},
{
"$ref": "#/components/parameters/endDate"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/proposedLeaveHoursResponse"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/leave/overview/{year}": {
"get": {
"tags": [
"Leave"
],
"description": "__Activity name :__ GetLeaveOverviewByEmploymentIdandYear\nDownload the leave overview for a year in a single PDF\n\n__Metadata :__ Possible options for `year` can be acquired (GET) the following URL /v2/providers/employers/employees/employments/{employmentId}/leave/overview/metadata.\n",
"summary": "Download the leave overview for an employment and year",
"operationId": "GetLeaveOverviewByEmploymentIdandYear",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/year"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/leaverequests": {
"get": {
"tags": [
"Leave request"
],
"description": "__Activity name :__ GetLeaveRequestsByEmploymentId\n\nGet a list of all leave requests for the given employment\n",
"summary": "leave requests by employment",
"operationId": "GetLeaveRequestsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/leaveRequest"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Leave request"
],
"description": "__Activity name :__ PostLeaveRequestByEmploymentId\n\nAdd a Leave request for an employment. This can only be done by the employee.\n",
"summary": "Create a leave request for an employment",
"operationId": "PostLeaveRequestByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/leaveRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/leaveRequest"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/leaverequests/{leaveRequestId}": {
"get": {
"tags": [
"Leave request"
],
"description": "__Activity name :__ GetLeaveRequestByLeaveRequestId\n\nGet the details of a single leave request\n",
"summary": "Details of a leave request",
"operationId": "GetLeaveRequestByLeaveRequestId",
"parameters": [
{
"$ref": "#/components/parameters/leaveRequestId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/leaveRequest"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Leave request"
],
"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.
\"\n",
"summary": "Change the details of a leave request",
"operationId": "PutLeaveRequestByLeaveRequestId",
"parameters": [
{
"$ref": "#/components/parameters/leaveRequestId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "__Important:__ A PUT is only allowed when the leave requests is in the status \"submitted\"/\"ingediend\". Only the field of `commentHandler` may be edited in other statuses.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/leaveRequestPut"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/leaveRequest"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/leavebalances": {
"get": {
"tags": [
"Leave balance"
],
"description": "__Activity name :__ GetLeaveBalancesByEmploymentId
Returns the yearly leave balances for each leave type.\n",
"summary": "List of yearly leave balances for each leave type.",
"operationId": "GetLeaveBalancesByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/leaveBalance"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/leavebalances": {
"get": {
"tags": [
"Leave balance"
],
"description": "__Activity name :__ GetLeaveBalancesByEmployerId
Returns the yearly leave balances for all employments\n",
"summary": "The leave balance for all employments",
"operationId": "GetLeaveBalancesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate-2"
},
{
"$ref": "#/components/parameters/leaveType"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/leaveBalanceEmployer"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/leavebalances/worth": {
"get": {
"tags": [
"Leave balance"
],
"description": "__Activity name :__ GetLeaveBalanceWorthByEmployerId
Returns the yearly leave balances and their worth for all employments\n",
"summary": "The leave balanceworth for all employments",
"operationId": "GetLeaveBalanceWorthByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate-2"
},
{
"$ref": "#/components/parameters/leaveType"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/leaveBalanceEmployerWithWorth"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/leavebalances/grouped": {
"get": {
"tags": [
"Leave balance"
],
"description": "__Activity name :__ GetLeaveBalancesGroupedByEmployerId
Returns the yearly leave balances total per leave type and total per groupBy\n",
"summary": "Summed up leave balance total and grouped by",
"operationId": "GetLeaveBalancesGroupedByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/referenceDate-2"
},
{
"$ref": "#/components/parameters/leaveType"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"name": "groupBy",
"in": "query",
"description": "Select the groupBy",
"required": true,
"schema": {
"type": "string",
"enum": [
"Department",
"Function"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/leaveBalanceEmployerGroupedBy"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/leavepolicies": {
"get": {
"tags": [
"Leave policy and employment links"
],
"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.
\n",
"summary": "Get list of linked leave policies for the employment",
"operationId": "GetLeavePoliciesByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/linkedLeavePolicy"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Leave policy and employment links"
],
"description": "__Activity name:__ PatchLeavePoliciesByEmploymentId\n\n__Metadata :__ Possible options can be acquired (GET) by adding `/metadata` to the POST URL.\n\nThis endpoint enables the user to link or unlink multiple 'linkages' with one call.\n",
"summary": "Link or unlink leave policies for the employment",
"operationId": "PatchLeavePoliciesByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "The request body contains an array of objects containing a `leavePolicy` and an `action` field.",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/linkedLeavePoliciesPatch"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/import/leave\"": {
"get": {
"tags": [
"Leave import"
],
"description": "__Activity name :__ GetLeaveImportDataByEmployerId\n\nReturns, for the given employer, a set of data that can be used as a base for importing leave through a csv file.\n\nNote that on importing, the columnnames must be in Dutch. (WerkgeverId\tPersnrVerl\tPersnr\tNaam\tIngangsdatum\tEinddatum\tSoort\tFactor\tEenheden)\n",
"summary": "Get data to create an importfile",
"operationId": "GetLeaveImportDataByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/leaveImportData"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Leave import"
],
"description": "__Activity name :__ PostLeaveImportDataByEmployerId\n\n\n\nImports a csv file containing leave records.\n",
"summary": "Import leave via a csv file",
"operationId": "PostLeaveImportDataByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "csv file to be uploaded.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/importFile"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"413": {
"$ref": "#/components/responses/requestEntityTooLarge"
},
"415": {
"$ref": "#/components/responses/unsupportedMediaType"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/leave": {
"post": {
"tags": [
"Collective leave"
],
"description": "__Activity name:__ PostCollectiveLeaveByEmployerId\n\nPost leave for a set of employments under an employer.\n\n__Metadata :__ There is no metadata endpoint for this resource.\n\n__Defaults :__ Defaults are available at /defaults.\n",
"summary": "Post leave for multiple employments.",
"operationId": "PostCollectiveLeaveByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Array of Leave objects",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/leave-2"
}
}
}
}
},
"responses": {
"202": {
"description": "OK. the specified leave is applied to the selected employments."
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview": {
"get": {
"tags": [
"Payroll administration process overview"
],
"description": "__Activity name :__ GetPayrollProcessOverviewByPayrollAdministrationId\n\nGet 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.\n__Metadata :__ Possible options for the query string parameters can be acquired (GET) via the `/metadata` endpoint. The URI for this endpoint is `../v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview/metadata`.\n\n__Defaults :__ Default values for the query string parameters can be acquired via the `/defaults` endpoint. The URI for this endpoint is `../v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollprocessoverview/defaults`.\n",
"summary": "Process Information about a payroll on administration level",
"operationId": "GetPayrollProcessOverviewByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollPeriodIdStart"
},
{
"$ref": "#/components/parameters/payrollPeriodIdEnd"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollProcessOverview"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollruns": {
"get": {
"tags": [
"Payroll run"
],
"description": "__Activity name :__ GetPayrollRunsByPayrollAdministrationId\n\nA list of payroll runs for an administration\n",
"summary": "List of payroll runs for an administration",
"operationId": "GetPayrollRunsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollRun"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}": {
"get": {
"tags": [
"Payroll run"
],
"description": "__Activity name :__ GetPayrollRunByPayrollRunId\n\nGet the details of a single payrollrun\n",
"summary": "Details of a payrollrun",
"operationId": "GetPayrollRunByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollrunId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payrollRun"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Payroll run"
],
"description": "__Activity name :__ PatchPayrollRunByPayrollRunId\n\nAllows the user to change the `availableForEmployeeDate` and `sendEmailToEmployee` fields\n",
"summary": "Change the availableForEmployee data",
"operationId": "PatchPayrollRunByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/payrollrunId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "The request body",
"required": true,
"content": {
"application/json;version=2020-03-16": {
"schema": {
"$ref": "#/components/schemas/availableForEmployeePatch"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payrollRun"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns": {
"patch": {
"tags": [
"Review payroll run"
],
"description": "__Activity name :__ PatchPayrollrunsByPayrollRunIds\n\nThis action may only be performed successfully of the following requirements are met;\n* The payroll run is ready for approval (status 1)\n\nUpdate the status of one or more payrollruns\n",
"summary": "Change the status of payrollruns",
"operationId": "PatchPayrollrunsByPayrollRunIds",
"requestBody": {
"description": "The request body contains an array of objects containing a `payrollrunId` and a `status` field.",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollrunStatusPatch"
}
}
}
}
},
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/periodreadyforpayroll": {
"post": {
"tags": [
"Period ready for payroll"
],
"description": "__Activity name :__ PostPeriodReadyForPayrollByPayrollAdministrationId\n\nSend an email to inform that the period is ready for payrolling.\n",
"summary": "Send an email to inform the salary administrator",
"operationId": "PostPeriodReadyForPayrollByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Report period ready for payroll",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/periodReadyForPayroll"
}
}
}
},
"responses": {
"202": {
"$ref": "#/components/responses/acceptedResponse"
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/payslips": {
"get": {
"tags": [
"Payroll run downloads"
],
"description": "__Activity name :__ GetPayslipsByPayrollRunId\n\n__Availability:__ This is endpoint is available for the Loket application only. It is not available for external parties\n\nReturns the payslips for a payroll run as a PDF file. By default the payslips are sorted by `employeeNumber`.\n",
"x-loket-implementation": "Dit is een gedeeltelijk design voor dit endpoint vanwege de focus op de WG startpagina in L3. In het volledige design wordt de sortering op employeeNumber de default response dus toekomstige aanpassingen zullen niet breaking zijn.***",
"summary": "Download payslips for a payroll run",
"operationId": "GetPayslipsByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollrunId"
},
{
"$ref": "#/components/parameters/sortOnField"
},
{
"$ref": "#/components/parameters/includeEmploymentsWithMijnLoketAccess"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/defaultset": {
"get": {
"tags": [
"Payroll run downloads"
],
"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.\n",
"summary": "Download the default set of downloads for a payroll run",
"operationId": "GetDefaultSetByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollrunId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/paymentoverviews": {
"get": {
"tags": [
"Payroll run downloads"
],
"description": "__Activity name :__ GetPaymentOverviewsByPayrollRunId\n\nReturns payment overviews for a payroll run as a PDF file. By default the payment overview 1 is returned.\n\n__Deprecated:__ Dit endpoint wordt vervangen door een nieuwe versie op URL `/verloningmicro/providers/employers/payrolladministrations/payrollruns/{id}/paymentsReport` (activity: GetPaymentsReportByPayrollRunId).\n",
"deprecated": true,
"x-loket-implementation": "Dit is een gedeeltelijk design voor dit endpoint vanwege de focus op de WG startpagina in L3. In het volledige design wordt default betalingsoverzicht 1 terugegeven dus toekomstige aanpassingen zullen niet breaking zijn.***",
"summary": "Download payment overviews for a payroll run",
"operationId": "GetPaymentOverviewsByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollrunId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/wagesheets": {
"get": {
"tags": [
"Payroll run downloads"
],
"description": "__Activity name :__ GetWageSheetsByPayrollRunId\n\nReturns 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.\n\n__Deprecated:__ Dit endpoint wordt vervangen door een nieuwe versie op URL `/verloningmicro/providers/employers/payrolladministrations/payrollruns/{id}/wagesheetReport` (activity: GetWageSheetsReportByPayrollRunId).\n",
"deprecated": true,
"x-loket-implementation": "Dit is een gedeeltelijk design voor dit endpoint vanwege de focus op de WG startpagina in L3. In het volledige design wordt default het Werkgever/werknemer overzicht terugegeven dus toekomstige aanpassingen zullen niet breaking zijn.***",
"summary": "Download wage sheets for a payroll run",
"operationId": "GetWageSheetsByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollrunId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/sepafiles": {
"get": {
"tags": [
"Payroll run downloads"
],
"description": "__Activity name :__ GetSepaFilesByPayrollRunId\n\nReturns the SEPA file(s) for the specified payroll run.",
"summary": "Get a list of SEPA files for a payroll run",
"operationId": "GetSepaFilesByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollrunId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/sepaFiles"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/sepahashes": {
"get": {
"tags": [
"Payroll run downloads"
],
"description": "__Activity name :__ GetSepaHashesByPayrollRunId\n\nReturns the hashes for the last created SEPA file(s) for the specified payroll run. The hashes are used to verify the integrity of the SEPA file(s). If no sepa file has been created, there will be no hashes available.",
"summary": "Get a list of SEPA hashes for a payroll run",
"operationId": "GetSepaHashesByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollrunId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/sepaHashes"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/sepafiles/{sepafileId}": {
"get": {
"tags": [
"Payroll run downloads"
],
"description": "__Activity name :__ GetSepaFileBySepaFileId\n\nReturns the specified SEPA payments file as a XML file.",
"summary": "Download a SEPA file",
"operationId": "GetSepaFileBySepaFileId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/sepafileId"
},
{
"$ref": "#/components/parameters/paymentType"
},
{
"$ref": "#/components/parameters/batchBooking"
},
{
"$ref": "#/components/parameters/requestedExecutionDate"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/xml": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"headers": {
"Content-Disposition": {
"description": "The filename. Explanation of the components of the filename -\\> SEPA_Clientnumber_year_payrollperiod_description\n",
"schema": {
"type": "string",
"example": "inline; filename=\"SEPA_568_2018_2_SALARISBETALING PERIODE 2.XML\""
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/totalsepafile": {
"get": {
"tags": [
"Payroll run downloads"
],
"description": "__Activity name :__ GetTotalSepaFileByPayrollRunId\n\nReturns 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.",
"summary": "Download a total SEPA file",
"operationId": "GetTotalSepaFileByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/payrollrunId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/paymentType"
},
{
"$ref": "#/components/parameters/batchBooking"
},
{
"$ref": "#/components/parameters/requestedExecutionDate"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/xml": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"headers": {
"Content-Disposition": {
"description": "The filename. Explanation of the components of the filename -\\> SEPA_Clientnumber_year_payrollperiod_description\n",
"schema": {
"type": "string",
"example": "inline; filename=\"SEPA_569_2018_1_TOTAAL.XML\""
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/runoverviews": {
"get": {
"tags": [
"Payroll run downloads"
],
"description": "__Activity name :__ GetRunOverviewsByPayrollRunId\n\nReturns run overviews for a payroll run as a PDF file.\n\n__Deprecated:__ Dit endpoint wordt vervangen door een nieuwe versie op URL `/verloningmicro/providers/employers/payrolladministrations/payrollruns/{id}/runoverviewsReport` (activity: GetRunOverviewsReportByPayrollRunId).\n",
"deprecated": true,
"summary": "Download run overviews for a payroll run",
"operationId": "GetRunOverviewsByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollrunId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/payrollcontrolregister": {
"get": {
"tags": [
"Payroll run downloads"
],
"description": "__Activity name :__ GetPayrollControlRegisterByPayrollRunId\n\nReturns payroll control register for a payroll run as a PDF file.\n\n__Deprecated:__ Dit endpoint wordt vervangen door een nieuwe versie op URL `/verloningmicro/providers/employers/payrolladministrations/payrollruns/{id}/payrollcontrolregisterreport` (activity: GetPayrollControlRegisterReportByPayrollRunId).\n",
"deprecated": true,
"summary": "Download payroll control register for a payroll run",
"operationId": "GetPayrollControlRegisterByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollrunId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/journalentriesperdistributionunitoverviews": {
"get": {
"tags": [
"Payroll run downloads"
],
"description": "__Activity name :__ GetJournalEntriesPerDistributionUnitOverviewsByPayrollRunId\n\nReturns the journal entries by distribution Unit for a payroll run as a PDF file.\n",
"summary": "Download the journal entries by distribution Unit.",
"operationId": "GetJournalEntriesPerDistributionUnitOverviewsByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollrunId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/errorsandwarnings": {
"get": {
"tags": [
"Payroll run downloads"
],
"description": "__Activity name :__ GetErrorsAndWarningsByPayrollRunId\n\nReturns an overview of errors and warnings that occurred during the payroll run as a PDF file.\n\n__Deprecated:__ Dit endpoint wordt vervangen door een nieuwe versie op URL `/verloningmicro/providers/employers/payrolladministrations/payrollruns/{id}/errorsandwarningsreport` (activity: GetErrorsAndWarningsReportByPayrollRunId).\n",
"deprecated": true,
"summary": "Download errors and warnings for a payroll run",
"operationId": "GetErrorsAndWarningsByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollrunId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/nonsepafile": {
"get": {
"tags": [
"Payroll run downloads"
],
"description": "__Activity name :__ GetNonSepaFileByPayrollRunId\n\nReturns the Non Sepa payments file as a XML file. Contains all Non Sepa payments for the specified payroll run.",
"summary": "Download a Non Sepa file",
"operationId": "GetNonSepaFileByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollrunId"
},
{
"$ref": "#/components/parameters/paymentReason"
},
{
"$ref": "#/components/parameters/requestedExecutionDate"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/xml": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"headers": {
"Content-Disposition": {
"description": "The filename. Explanation of the components of the filename -\\> NONSEPA_Clientnumber_year_payrollrunsequencenumber\n",
"schema": {
"type": "string",
"example": "inline; filename=\"NONSEPA_569_2018_volgnummerrun.XML\""
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriodDataAuditTrail": {
"get": {
"tags": [
"Audit trail"
],
"description": "__Activity name :__ GetPayrollPeriodDataAuditTrailByPayrollAdministrationId\n\nReturns the changes that were made in the payroll period data from the given start up to and including the given end date.",
"summary": "Download the audit trail for the payroll period data",
"operationId": "GetPayrollPeriodDataAuditTrailByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/startDateRequired"
},
{
"$ref": "#/components/parameters/endDateRequired"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/employmentPayrollDataAuditTrail": {
"get": {
"tags": [
"Audit trail payroll run"
],
"description": "__Activity name :__ GetEmploymentPayrollDataAuditTrailByPayrollAdministrationId\n\nReturns the changes that were made in the payroll data for the employments. \n\nThis includes resources such as (allmost all payroll related resources except `payroll period data` which has its own audit trail download):\n- Wage\n- Working hours\n- Bennefits and deductions\n- Employment\n- Fiscal properties\n- Organizational entity",
"summary": "Download the audit trail for the employment payroll data",
"operationId": "GetEmploymentPayrollDataAuditTrailByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/startDateRequired"
},
{
"$ref": "#/components/parameters/endDateRequired"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods": {
"get": {
"tags": [
"Payroll periods"
],
"description": "__Activity name :__ GetPayrollPeriodsByPayrollAdministrationId\n\nReturns a list of all payroll periods available for the given payroll administration \n",
"summary": "List of all available payroll periods and runs",
"operationId": "GetPayrollPeriodsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollPeriods"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/minimized": {
"get": {
"tags": [
"Payroll periods"
],
"description": "__Activity name :__ GetPayrollPeriodsMinimizedByPayrollAdministrationId\n\nReturns a list of all payroll periods available for the given payroll administration \n",
"summary": "List of all available payroll periods",
"operationId": "GetPayrollPeriodsMinimizedByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollPeriodsMinimized"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/{payrollPeriodId}/payrollresults": {
"get": {
"tags": [
"Payroll results"
],
"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 possible 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 possible 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).
\n",
"summary": "Get payroll results for the given payroll period",
"operationId": "GetPayrollPeriodResultsByPayrollAdministrationIdAndPayrollPeriodId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/payrollPeriodId-2"
},
{
"$ref": "#/components/parameters/payrollComponents"
},
{
"$ref": "#/components/parameters/payrollComponentSet-2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollResults-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/compare": {
"get": {
"tags": [
"Payroll results"
],
"description": "__Activity name :__ GetComparePayrollPeriodsByPayrollAdministrationId \n\nReturns 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 \n",
"summary": "Get the results of the given payroll period and the one before",
"operationId": "GetComparePayrollPeriodsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/payrollPeriodCompareId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollPeriodCompare"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/payrollresults/statistics/data": {
"get": {
"tags": [
"Payroll results"
],
"description": "__Activity name :__ GetPayrollResultStatisticsDataByEmployerId \n\nReturns a compact set of data for payrollresults for a range of components for a range of payroll periods.\n",
"summary": "basic payrollresults statistics",
"operationId": "GetPayrollResultStatisticsDataByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/startDateRequired"
},
{
"$ref": "#/components/parameters/endDateRequired"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollResultsCompact"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/payrollperiods/payrollcomponents/{payrollComponent}": {
"get": {
"tags": [
"Payroll results"
],
"description": "__Activity name :__ GetPayrollComponentResultsByPayrollAdministrationIdAndPayrollComponent \n\nReturns the results of a specific payrollcomponent for a range of payroll periods so a comparison can be made.\n",
"summary": "Get the results of the given payroll period and the one before",
"operationId": "GetPayrollComponentResultsByPayrollAdministrationIdAndPayrollComponent",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/payrollComponents"
},
{
"$ref": "#/components/parameters/payrollPeriodIdStart-2"
},
{
"$ref": "#/components/parameters/payrollPeriodIdEnd-2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollComponentResults"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollperiods/payrollresults/compare": {
"get": {
"tags": [
"Payroll results"
],
"description": "__Activity name :__ GetComparePayrollPeriodResultsByBearerToken\n\nReturns the results of two given payroll periods and a comparison between them.\n",
"summary": "Compare payrollresults for two payrollperiods at providerlevel",
"operationId": "GetComparePayrollPeriodResultsByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/acceptAsync"
},
{
"$ref": "#/components/parameters/PayrollPeriodToCompare"
},
{
"$ref": "#/components/parameters/PayrollPeriodCompareTo"
},
{
"$ref": "#/components/parameters/payrollComponentId-2"
},
{
"$ref": "#/components/parameters/includeTableAndOrTariff"
},
{
"$ref": "#/components/parameters/includeFromDeviationPercentage"
},
{
"$ref": "#/components/parameters/sortOnField-2"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/async"
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/results": {
"get": {
"tags": [
"Payroll run results"
],
"description": "__Activity name :__ GetPayrollRunResultsByPayrollRunId \n\nReturns the results for the payroll run\n",
"x-loket-implementation": "Dit is een gedeeltelijk design voor dit endpoint vanwege de focus op de WG startpagina in L3. In het volledige design wordt de sortering op employeeNumber de default response dus toekomstige aanpassingen zullen niet breaking zijn.***",
"summary": "Get results for a payroll run",
"operationId": "GetPayrollRunResultsByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollrunId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employments"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/BalanceSheet": {
"get": {
"tags": [
"Payroll run downloads"
],
"description": "__Activity name :__ GetPayrollRunBalanceSheetByPayrollRunId\n\nThis endpoint returns per payroll components, marked as relevant for the general ledge (balance sheet), the sum of the values.\n\nIf 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\"\n",
"summary": "Get payroll run balance sheet",
"operationId": "GetPayrollRunBalanceSheetByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollrunId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/balanceSheet"
}
}
}
}
]
}
},
"text/csv": {
"schema": {
"type": "string",
"description": "The output in CSV",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollresults": {
"get": {
"tags": [
"Payroll results"
],
"description": "__Activity name :__ GetPayrollResultsByPayrollAdministrationId
Returns the payroll results and information on the employments for all payrollruns in a given period or periods. The results are grouped by period.
__Note :__ This endpoint is related to the `GetPayrollRunResultsByPayrollRunId` endpoint.
__Note :__ This endpoint replaces the 'Export loonresultaten' report.
\n",
"summary": "Payroll results for several periods",
"operationId": "GetPayrollResultsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/payrollPeriodIdStart-2"
},
{
"$ref": "#/components/parameters/payrollPeriodIdEnd-2"
},
{
"$ref": "#/components/parameters/payrollComponentSetId-2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollResults-3"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/payrollresults\"": {
"get": {
"tags": [
"Payroll results"
],
"description": "__Activity name :__ GetPayrollResultsByPayrollRunId
Returns the payroll results and information on the employments for a given payrollrun.
__Note :__ This endpoint is related to the `GetPayrollResultsByPayrollAdministrationId` endpoint.
\n",
"summary": "Payroll results for a payrollrun",
"operationId": "GetPayrollResultsByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollrunId"
},
{
"$ref": "#/components/parameters/payrollComponentSetId-2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollResults-3"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/payrollresults\"": {
"get": {
"tags": [
"Payroll administration reports"
],
"description": "__Activity name :__ GetPayrollResultsInColumnsPerPeriodByPayrollAdministrationId\n\nThis overview contains wage results. The wage results are subdivided per period. A column is included for each period. A total column is included per year. The overview contains the wage results of all components as standard. The number of components can be limited by specifying a component set.\n",
"summary": "Download payrollresults in columns",
"operationId": "GetPayrollResultsInColumnsPerPeriodByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/payrollPeriodIdStart-2"
},
{
"$ref": "#/components/parameters/payrollPeriodIdEnd-2"
},
{
"$ref": "#/components/parameters/payrollComponentSetId-2"
},
{
"$ref": "#/components/parameters/acceptNoJson"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/payrollresults/grouped\"": {
"get": {
"tags": [
"Payroll administration reports"
],
"description": "__Activity name :__ GetPayrollResultsInColumnsPerPeriodGroupedByPayrollAdministrationId\n\nThis overview contains wage results. The wage results are subdivided per period. A column is included for each period. A total column is included per year. The overview contains the wage results of component 157. \n",
"summary": "Download FTE payrollresults in columns",
"operationId": "GetPayrollResultsInColumnsPerPeriodGroupedByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/payrollPeriodIdStart-2"
},
{
"$ref": "#/components/parameters/payrollPeriodIdEnd-2"
},
{
"$ref": "#/components/parameters/acceptNoJson"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/providers": {
"get": {
"tags": [
"Provider"
],
"description": "__Activity name :__ GetProvidersByUser\nGet a list of all providers accessible to the current user.\nNote: With the current functioning of Loket, the list will always contain 1 provider.\nNote: This endpoint is typically not relevant for most external parties, as the GetEmployerByUser endpoint will be much more relevant as starting point.\n",
"summary": "List of providers",
"operationId": "GetProvidersByUser",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/provider"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/logo": {
"get": {
"tags": [
"Provider"
],
"description": "__Activity name :__ GetProviderLogo\nThis activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.\n__Caching:__ This resource changes very infrequently and can be cached for a longer time.\nGet the logo of the provider of the user. In case no logo is know the service will return a 404.",
"summary": "Download the provider logo",
"operationId": "GetProviderLogo",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/jpg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/logo/{version}": {
"get": {
"tags": [
"Provider"
],
"description": "__Activity name :__ GetProviderLogo\nThis activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.\n__Caching:__ This resource changes very infrequently and can be cached for a longer time.\nGet the logo of the provider of the user. In case no logo is know the service will return a 404.",
"summary": "Download the provider logo",
"operationId": "GetProviderLogoByVersion",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/version-2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/jpg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/contactinformation": {
"get": {
"tags": [
"Provider"
],
"description": "__Activity name :__ GetProviderContactInformationByProviderId\nHaal de contactinformatie op van de opgegeven providerId. Bevat onder andere adres- en contactgegevens.\n",
"summary": "Retrieve provider contact information",
"operationId": "GetProviderContactInformationByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/providerContactInformation"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/billing/providers/{providerId}/billableitems": {
"get": {
"tags": [
"Billable items"
],
"description": "__Activity name :__ GetBillableItemsByProviderId\n\nGet a list of all billable items for the provider. \n",
"summary": "Overview of number of billable items per employer",
"operationId": "GetBillableItemsByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/startDateRequired"
},
{
"$ref": "#/components/parameters/endDateRequired"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/billableItemProviderObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/dashboard": {
"get": {
"tags": [
"Provider dashboard"
],
"description": "__Activity name :__ GetProviderDashboardByProviderId\n\nGet the url for the PowerBI dashboard for this provider.\nPlease note: the PowerBI dashboard is only accessible for users with an assigned dashboard license.\n",
"summary": "Dashboard for a provider",
"operationId": "GetProviderDashboardByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/dashboard-2"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/logos": {
"get": {
"tags": [
"Provider"
],
"description": "__Activity name :__ GetProviderLogosByProviderId\n\nGet a list of all logos that are available at providerlevel. Other endpoints can be used to set the logo as default for all employers or to set the logo as a aberrant provider logo at employer level.\n",
"summary": "Logos at providerlevel",
"operationId": "GetProviderLogosByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/logoObjectList"
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Provider"
],
"description": "__Activity name :__ PostProviderLogoByProviderId\n\nUpload a logo at providerlevel. Other endpoints can be used to set the logo as default for all employers or to set the logo as a aberrant provider logo at employer level.\n",
"summary": "Upload a logo for the provider",
"operationId": "PostProviderLogoByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Logo to be uploaded for the provider.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/logoObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/logoObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/logos/{logoId}": {
"get": {
"tags": [
"Provider"
],
"description": "__Activity name :__ GetProviderLogoByLogoId\n\nGet a logo that is available at providerlevel. Other endpoints can be used to set the logo as default for all employers or to set the logo as a aberrant provider logo at employer level.\n",
"summary": "Logo at providerlevel",
"operationId": "GetProviderLogoByLogoId",
"parameters": [
{
"$ref": "#/components/parameters/logoId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/logoObject"
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Provider"
],
"description": "__Activity name :__ PutProviderLogoByLogoId\n\nEdit a logo at providerlevel. Other endpoints can be used to set the logo as default for all employers or to set the logo as a aberrant provider logo at employer level.\n",
"summary": "Edit a provider logo",
"operationId": "PutProviderLogoByLogoId",
"parameters": [
{
"$ref": "#/components/parameters/logoId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/logoObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/logoObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Provider"
],
"description": "__Activity name :__ DeleteProviderLogoByLogoId\n",
"summary": "Delete a logo at providerlevel",
"operationId": "DeleteProviderLogoByLogoId",
"parameters": [
{
"$ref": "#/components/parameters/logoId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/logos/{logoId}/logo": {
"get": {
"tags": [
"Provider"
],
"description": "__Activity name :__ GetProviderLogoOnlyByLogoId\n\nGet the logo that is available at providerlevel, without additional properties. Other endpoints can be used to set the logo as default for all employers or to set the logo as a aberrant provider logo at employer level.\n",
"summary": "Logo without properties at providerlevel",
"operationId": "GetProviderLogoOnlyByLogoId",
"parameters": [
{
"$ref": "#/components/parameters/logoId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary",
"description": "A binary string representation of the image."
}
},
"image/jpg": {
"schema": {
"type": "string",
"format": "binary",
"description": "A binary string representation of the image."
}
},
"image/png": {
"schema": {
"type": "string",
"format": "binary",
"description": "A binary string representation of the image."
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/configuration": {
"get": {
"tags": [
"Provider configuration"
],
"description": "__Activity name :__ GetProviderConfigurationByProviderId\n\nGet the configuration at provider level.\n",
"summary": "Provider configuration",
"operationId": "GetProviderConfigurationByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/configurationObject-2"
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Provider configuration"
],
"description": "__Activity name :__ PutProviderConfigurationByProviderId\n\nEdit the configuration at provider level.\n",
"summary": "Edit provider configuration",
"operationId": "PutProviderConfigurationByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/configurationObject-2"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/configurationObject-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/configuration/payslip": {
"get": {
"tags": [
"Provider payslip configuration"
],
"description": "__Activity name :__ GetProviderPayslipConfigurationByProviderId\n\nGet the payslip configuration at provider level.\n",
"summary": "Provider payslip configuration",
"operationId": "GetProviderPayslipConfigurationByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payslipConfigurationObject"
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Provider payslip configuration"
],
"description": "__Activity name :__ PutProviderPayslipConfigurationByProviderId\n\nEdit the payslip configuration at provider level.\n",
"summary": "Edit provider configuration",
"operationId": "PutProviderPayslipConfigurationByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/payslipConfigurationObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payslipConfigurationObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/configuration/payslip/logo": {
"get": {
"tags": [
"Provider payslip configuration"
],
"description": "__Activity name :__ GetProviderPayslipLogoByProviderId\n\nGet the provider payslip logo. This logo serves as a default logo for the payslip.\n",
"summary": "Provider payslip logo",
"operationId": "GetProviderPayslipLogoByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/jpg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Provider payslip configuration"
],
"description": "__Activity name:__ DeleteProviderPayslipLogoByProviderId\n\n\nDelete the provider payslip logo\n",
"summary": "Delete the provider payslip logo",
"operationId": "DeleteProviderPayslipLogoByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Provider payslip configuration"
],
"description": "__Activity name :__ PostProviderPayslipLogoByProviderId\n\n\nUpload a logo for the payslip at providerlevel.\n",
"summary": "Upload a logo for the payslip at providerlevel.",
"operationId": "PostProviderPayslipLogoByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Logo to be uploaded for the payslip at providerlevel.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/logoPostObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/messageWarning-2"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/notificationsettings": {
"get": {
"tags": [
"Provider notification settings"
],
"description": "__Activity name :__ GetNotificationSettingsByProviderId \n\n\n List the configuration per notification for the provider\n",
"summary": "The notification settings for the provider",
"operationId": "GetNotificationSettingsByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notifications"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Provider notification settings"
],
"summary": "Manage the Provider notification settings",
"description": "__Activity name :__ PatchProviderNotificationSettingsByProviderId\n\nManage the Provider notifications.\n\n\nOnly the changes supplied are processed. Existing records not supplied in the request body will be left unchanged. e.g. If three notifications are enabled and a patch is performed with in the body one new notification with the `isEnabled` = true. The result will be 4 enabled notifications.\n",
"parameters": [
{
"$ref": "#/components/parameters/providerId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"operationId": "PatchProviderNotificationSettingsByProviderId",
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notifications"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/groupclassifications": {
"get": {
"tags": [
"GroupClassification"
],
"description": "__Activity name :__ GetGroupClassificationsByProviderId\n\n\nGet a list of the groupclassifications for an provider.\n\n__Note:__ The groupclassifications defined at the provider level can be used as value for the field groupClassification at administration level.\n",
"summary": "List groupclassifications for an provider",
"operationId": "GetGroupClassificationsByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/groupClassification-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"GroupClassification"
],
"description": "__Activity name :__ PostGroupClassificationByProviderId\n",
"summary": "Add a groupclassification for an provider",
"operationId": "PostGroupClassificationByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a groupclassification",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/groupClassification-2"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/groupClassification-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/groupclassifications/{groupClassificationId}": {
"put": {
"tags": [
"GroupClassification"
],
"description": "__Activity name :__ PutGroupClassificationByGroupClassificationId\n",
"summary": "Edit a groupclassification record",
"operationId": "PutGroupClassificationByGroupClassificationId",
"parameters": [
{
"$ref": "#/components/parameters/groupClassificationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/groupClassification-2"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/groupClassification-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"GroupClassification"
],
"description": "__Activity name :__ DeleteGroupClassificationByGroupClassificationId\n\n\nDelete an existing groupclassification record\n",
"summary": "Delete a groupclassification record",
"operationId": "DeleteGroupClassificationByGroupClassificationId",
"parameters": [
{
"$ref": "#/components/parameters/groupClassificationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/workrelatedcostsutilization": {
"get": {
"tags": [
"Provider reports misc"
],
"description": "__Activity name :__ GetWorkRelatedCostsUtilizationByBearerToken\n\nReturns a list of all clients with their cumulative work‑cost metrics for the current fiscal year. Monetary amounts are expressed in euros with two decimal places.\n",
"summary": "WorkrelatedCostsUtilization per administration.",
"operationId": "GetWorkRelatedCostsUtilizationByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/acceptAsync"
},
{
"$ref": "#/components/parameters/year-3"
},
{
"$ref": "#/components/parameters/sortOnField-3"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/async"
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/qwoatermicroservice/providers/employers/dossier/usage": {
"get": {
"tags": [
"Provider reports misc"
],
"description": "__Activity name :__ GetDossierUsageByBearerToken\n\nReturns a list of all clients with their dossier metrics as of the referenceDate\n",
"summary": "Dossier Usage per employer.",
"operationId": "GetDossierUsageByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/acceptAsync"
},
{
"$ref": "#/components/parameters/referenceDateOptional"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/async"
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/qwoatermicroservice/providers/employers/signature/usage": {
"get": {
"tags": [
"Provider reports misc"
],
"description": "__Activity name :__ GetSignatureUsageByBearerToken\n\nReturns the number of signatures per employer for the given period. The startDate and endDate are required parameters.\n",
"summary": "Signature usage per employer.",
"operationId": "GetSignatureUsageByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/acceptAsync"
},
{
"$ref": "#/components/parameters/startDateRequired"
},
{
"$ref": "#/components/parameters/endDateRequired"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/async"
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/authorizationsets": {
"get": {
"tags": [
"Authorization sets"
],
"description": "__Activity name :__ GetAuthorizationSetsByProviderId \n\n\n List the available authorization sets. \n",
"summary": "List of authorization sets",
"operationId": "GetAuthorizationSetsByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/authorizationSets"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Authorization sets"
],
"description": "__Activity name :__ PostAuthorizationSetByProviderId \n\n\n Create an authorization set. \n",
"summary": "Create an AuthorizationSet for an provider",
"operationId": "PostAuthorizationSetByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "authorizationSet to add.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/authorizationSets"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/authorizationSets"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/authorizationsets/{authorizationSetId}": {
"get": {
"tags": [
"Authorization sets"
],
"description": "__Activity name :__ GetAuthorizationSetByAuthorizationSetId \n\n\n Details of an authorization set. \n",
"summary": "Details of a authorization set",
"operationId": "GetAuthorizationSetsByAuthorizationSetId",
"parameters": [
{
"$ref": "#/components/parameters/authorizationSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/authorizationSets"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Authorization sets"
],
"description": "__Activity name :__ PutAuthorizationSetByAuthorizationSetId\n\n Edit the details of an authorizationset.\n",
"summary": "Edit the details of an authorizationset",
"operationId": "PutAuthorizationSetByAuthorizationSetId",
"parameters": [
{
"$ref": "#/components/parameters/authorizationSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Autorizationset to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/authorizationSets"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/authorizationSets"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Authorization sets"
],
"description": "__Activity name:__ DeleteAuthorizationSetByAuthorizationSetId\n\nDelete an AuthorizationSet.\n",
"summary": "Delete a specific AuthorizationSet",
"operationId": "DeleteAuthorizationSetByAuthorizationSetId",
"parameters": [
{
"$ref": "#/components/parameters/authorizationSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/modulesets": {
"get": {
"tags": [
"Module sets"
],
"description": "__Activity name :__ GetModuleSetsByProviderId \n\n\n List the available module sets.\n",
"summary": "List of module sets",
"operationId": "GetModuleSetsByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moduleSets"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Module sets"
],
"description": "__Activity name :__ PostModuleSetByProviderId \n\n\n Create an module set. \n",
"summary": "Create a module set for an provider",
"operationId": "PostModuleSetByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "module set to add.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/moduleSets"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/moduleSets"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/modulesets/{moduleSetId}": {
"get": {
"tags": [
"Module sets"
],
"description": "__Activity name :__ GetModuleSetByModuleSetId \n\n\n Details of an module set. \n",
"summary": "Details of a module set",
"operationId": "GetModuleSetsByModuleSetId",
"parameters": [
{
"$ref": "#/components/parameters/moduleSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/moduleSets"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Module sets"
],
"description": "__Activity name :__ PatchModuleSetByModuleSetId\n\n Patch the details of an module set. Modules can be added or deleted with the enable / disable flag.\n",
"summary": "Edit the details of an module set",
"operationId": "PatchModuleSetByModuleSetId",
"parameters": [
{
"$ref": "#/components/parameters/moduleSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Autorizationset to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/moduleSetPatch"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/moduleSets"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Module sets"
],
"description": "__Activity name:__ DeleteModuleSetByModuleSetId\n\nDelete a module set.\n",
"summary": "Delete a specific module set",
"operationId": "DeleteModuleSetByModuleSetId",
"parameters": [
{
"$ref": "#/components/parameters/moduleSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/moduleset": {
"get": {
"tags": [
"Module sets"
],
"description": "__Activity name :__ GetModuleSetByEmployerId\nGet the module set assigned to a specific employer.\n",
"summary": "Get module set for an employer",
"operationId": "GetModuleSetByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/moduleSetEmployer"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Module sets"
],
"description": "__Activity name :__ PutModuleSetByEmployerId\nAssign or update a module set for an employer.\n",
"summary": "Update module set for an employer",
"operationId": "PutModuleSetByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Module set to assign or update.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/moduleSetEmployerPut"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/moduleSetEmployer"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/notificationsets": {
"get": {
"tags": [
"Notification sets"
],
"description": "__Activity name :__ GetNotificationSetsByProviderId \n\n\n List the available notification sets. \n",
"summary": "List of notification sets",
"operationId": "GetNotificationSetsByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notificationSets"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Notification sets"
],
"description": "__Activity name :__ PostNotificationSetByProviderId \n\n\n Create a notification set. \n",
"summary": "Create a notification set for an provider",
"operationId": "PostNotificationSetByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "notification set to add.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/notificationSets"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/notificationSets"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/notificationsets/{notificationSetId}": {
"get": {
"tags": [
"Notification sets"
],
"description": "__Activity name :__ GetNotificationSetByNotificationSetId \n\n\n Details of an notification set.\n",
"summary": "Details of a notification set",
"operationId": "GetNotificationSetByNotificationSetId",
"parameters": [
{
"$ref": "#/components/parameters/notificationSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/notificationSets"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Notification sets"
],
"description": "__Activity name :__ PatchNotificationSetByNotificationSetId\n\n Patch the details of an notification set. Notifications can be added or deleted with the enable / disable flag.\n",
"summary": "Edit the details of an notification set",
"operationId": "PatchNotificationSetByNotificationSetId",
"parameters": [
{
"$ref": "#/components/parameters/notificationSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Autorizationset to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/notificationSetPatch"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/notificationSets"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Notification sets"
],
"description": "__Activity name:__ DeleteNotificationSetByNotificationSetId\n\nDelete a notification set.\n",
"summary": "Delete a specific notification set",
"operationId": "DeleteNotificationSetByNotificationSetId",
"parameters": [
{
"$ref": "#/components/parameters/notificationSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollperiods/{payrollPeriodId}/payrollruns/status": {
"get": {
"tags": [
"Payroll process status"
],
"description": "__Activity name :__ GetPayrollStatusByBearerToken\n\nReturns an array of payrollAdministrations. Each object contains information about the payrolladministration and the payroll run status for an payroll period.\n",
"summary": "Payroll status for each administration.",
"operationId": "GetPayrollStatusByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollPeriodIdPath"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollStatus"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollperiods/{payrollPeriodId}/payrolltaxreturns/status\"": {
"get": {
"tags": [
"Payroll process status"
],
"description": "__Activity name :__ GetPayrollTaxReturnStatusByBearerToken\n\nReturns an array of payrollAdministrations. Each object contains information about the payrolladministration and the payrolltaxreturn status for an payroll period.\n",
"summary": "PayrollTaxreturn status for each wageTaxNumber.",
"operationId": "GetPayrollTaxReturnStatusByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollPeriodIdPath"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollTaxReturnStatus"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollperiods/{payrollPeriodId}/pensiondeclaration/status": {
"get": {
"tags": [
"Payroll process status"
],
"description": "__Activity name :__ GetPensionDeclarationStatusByBearerToken\n\nReturns an array of payrollAdministrations. Each object contains information about the payrolladministration and the upa pension declaration status for an payroll period. Multiple pension declarations can be present for a single payroll period.\n",
"summary": "Pension declaration status for each externalParty.",
"operationId": "GetPensionDeclarationStatusByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollPeriodIdPath"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/pensionDeclarationStatus"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/year/providers/employers/payrolladministrations/years/{year}/status": {
"get": {
"tags": [
"Payroll process status"
],
"description": "__Activity name :__ GetYearStatusByBearerToken\n\nReturns an array of payrollAdministrations. Each object contains information about the payrolladministration and the year.\n",
"summary": "Year status for each administration",
"operationId": "GetYearStatusByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/yearPath"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/yearStatus"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns": {
"get": {
"tags": [
"Journal run"
],
"description": "__Activity name :__ GetJournalRunsByPayrollAdministrationId\n\nReturns the journal runs for a payroll administration.\n",
"summary": "List of journal runs for an administration",
"operationId": "GetJournalRunsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/journalRun"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalruns/{journalrunId}": {
"get": {
"tags": [
"Journal run"
],
"description": "__Activity name :__ GetJournalRunByJournalRunId\n\nReturns the details of a journal run. \n",
"summary": "Details of a journal run",
"operationId": "GetJournalRunByJournalRunId",
"parameters": [
{
"$ref": "#/components/parameters/journalrunId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalRun"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Journal run"
],
"description": "__Activity name :__ PatchJournalRunByJournalRunId\n\nUpdate the status of a journal run\n* 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.\n* 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.\n",
"summary": "Change the status of a journal run",
"operationId": "PatchJournalRunByJournalRunId",
"requestBody": {
"description": "Change the status of a journal run",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/journalrunStatusPatch"
}
}
}
},
"parameters": [
{
"$ref": "#/components/parameters/journalrunId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns/initiate": {
"post": {
"tags": [
"Journal run"
],
"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 successfully 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 successful 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.\n",
"summary": "Initiate journal run (journaliseren)",
"operationId": "PostInitiateJournalRunByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalRun"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalruns/{journalrunId}/undo": {
"post": {
"tags": [
"Journal run"
],
"description": "__Activity name :__ PostUndoJournalRunByJournalRunId
This is a controller endpoint to perform an action.
In the older Loket GUI this specific action is referred to as 'Verwijderen journalrun' If this action is performed successfully then the journalrun will be 'deleted' in the sense that its results will be undone.
Please note that removing a journalrun does not remove any data in other applications.
__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.
__Defaults :__ Defaults GET endpoint is available for this controller endpoint at the path `.../payrolladministrations/{payrollAdministrationId}/journalruns/undo/defaults`.\n",
"summary": "Undo journal run (verwijderen journaalrun)",
"operationId": "PostUndoJournalRunByJournalRunId",
"parameters": [
{
"$ref": "#/components/parameters/journalrunId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/journalruns/recalculate": {
"post": {
"tags": [
"Journal run"
],
"description": "__Activity name :__ PostRecalculateJournalRunByPayrollrunId
This is a controller endpoint to perform an action.
This action can only be performed for a payrollrun for which a successful journalrun allready exists. A recalculation of the journal for the given payroll run will result in the differences between the new run and all the previous runs. This allows a user to change the allocation of costs after a successful journal run and with a recalculation run have the correction to send to the financial software.
e.g. For a given employment the cost (500€) was incorrectly booked on the cost unit \\Sales\\\" this should have been \\\"IT\\\". After changing the journal alocation for this employment a recalculation was done (no other changes were made). This will result in 2 lines in the new journal run -500 for \\\"sales\\\" and +500 for \\\"IT\\\"
__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.
__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.\"\n",
"summary": "Recalculate journal for a payroll run",
"operationId": "PostRecalculateJournalRunByPayrollrunId",
"parameters": [
{
"$ref": "#/components/parameters/payrollrunId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalruns/{journalrunId}/results": {
"get": {
"tags": [
"Journal run results"
],
"description": "__Activity name :__ GetJournalRunResultsByJournalRunId\n\nReturns 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.\n",
"summary": "Get journal results for a journal run",
"operationId": "GetJournalRunResultsByJournalRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/journalrunId"
},
{
"$ref": "#/components/parameters/consolidate"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/journalRunResults"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/journalruns/cumulativeresults": {
"get": {
"tags": [
"Journal run cumulative results"
],
"description": "__Activity name :__ GetCumulativeJournalRunResultsByPayrollAdministrationId\n\nReturns the journal run results for the the payroll administration for the given start- and end period.\n",
"summary": "Get journal results for a payroll administration",
"operationId": "GetCumulativeJournalRunResultsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/startPeriod-2"
},
{
"$ref": "#/components/parameters/endPeriod-2"
},
{
"$ref": "#/components/parameters/consolidate"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/journalRunCumulativeResults"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalruns/{journalrunId}/report": {
"get": {
"tags": [
"Journal run results"
],
"description": "__Activity name :__ GetJournalRunReportByJournalRunId\n\nReturns the journal run results for the journal run in a pdf report.\n",
"summary": "Get journal report for a journal run",
"operationId": "GetJournalRunReportByJournalRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/journalrunId"
},
{
"$ref": "#/components/parameters/consolidate"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalruns/{journalrunId}/runoverview": {
"get": {
"tags": [
"Journal run overview"
],
"description": "__Activity name :__ GetRunOverviewByJournalRunId\n\nReturns 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.\n",
"summary": "Get journal run overview for a journal run",
"operationId": "GetRunOverviewByJournalRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/journalrunId"
},
{
"$ref": "#/components/parameters/reportJournalNumber"
},
{
"$ref": "#/components/parameters/reportVoucherNumber"
},
{
"$ref": "#/components/parameters/reportDescription"
},
{
"$ref": "#/components/parameters/reportYear-2"
},
{
"$ref": "#/components/parameters/reportPeriodNumber"
},
{
"$ref": "#/components/parameters/reportDate"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalruns/{journalrunId}/runoverviewperemployment": {
"get": {
"tags": [
"Journal run overview"
],
"description": "__Activity name :__ GetRunOverviewPerEmploymentByJournalRunId\n\nReturns 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.\n",
"summary": "Get journal run overview per employment for a journal run",
"operationId": "GetRunOverviewPerEmploymentByJournalRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/journalrunId"
},
{
"$ref": "#/components/parameters/reportJournalNumber"
},
{
"$ref": "#/components/parameters/reportVoucherNumber"
},
{
"$ref": "#/components/parameters/reportDescription"
},
{
"$ref": "#/components/parameters/reportYear-2"
},
{
"$ref": "#/components/parameters/reportPeriodNumber"
},
{
"$ref": "#/components/parameters/reportDate"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/csv": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalruns/{journalrunId}/exportAuditTrail": {
"get": {
"tags": [
"Journal run"
],
"description": "__Activity name :__ GetJournalRunExportAuditTrailByJournalRunId\n\nReturns the export audit trail for a journal run\n",
"summary": "List export attempts for a journal run",
"operationId": "GetJournalRunExportAuditTrailByJournalRunId",
"parameters": [
{
"$ref": "#/components/parameters/journalrunId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/journalRunExportAuditTrail"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalruns/{journalrunId}/errors": {
"get": {
"tags": [
"Journal run"
],
"description": "__Activity name :__ GetJournalRunErrorsByJournalRunId\n\nErrors that occured while processing the journalrun can be obtained via this endpoint.\n",
"summary": "Errors of a journal run",
"operationId": "GetJournalRunErrorsByJournalRunId",
"parameters": [
{
"$ref": "#/components/parameters/journalrunId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/journalRunError"
}
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalruns/{journalrunId}/send": {
"post": {
"tags": [
"Journal run"
],
"description": "__Activity name :__ PostSendJournalRunExportByJournalRunId\n\nSend 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. \n\nThere are two metadata endpoints: \n\n- /journalruns/{journalrunId}/send/metadata\n\n- /journalruns/{journalrunId}/send/metadata/accountId/{accountId}\n",
"summary": "Send the journal run",
"operationId": "PostSendJournalRunExportByJournalRunId",
"requestBody": {
"description": "Send the journal run to an external application",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/journalrunExportSend"
}
}
}
},
"parameters": [
{
"$ref": "#/components/parameters/journalrunId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"202": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalrunExportSend"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalruns/{journalrunId}/download": {
"post": {
"tags": [
"Journal run"
],
"description": "__Activity name :__ PostDownloadJournalRunExportByJournalRunId\n\nDownload a journal run to a journal application. Use the defaults and metadata to acquire the journal application settings.\n",
"summary": "Download the journal run",
"operationId": "PostDownloadJournalRunExportByJournalRunId",
"requestBody": {
"description": "Download the journal run to an external application",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/journalrunExportDownload"
}
}
}
},
"parameters": [
{
"$ref": "#/components/parameters/journalrunId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalrunExportDownload"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/journalConfigurations": {
"get": {
"tags": [
"Journal configuration"
],
"description": "__Activity name:__ GetJournalConfigurationsByPayrollAdministrationId
Get the list of journal configurations for a specific payroll administration.
\n",
"summary": "List of journal configurations",
"operationId": "GetJournalConfigurationsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/journalConfigurationObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Journal configuration"
],
"description": "__Activity name:__ PostJournalConfigurationByPayrollAdministrationId
Create a new journal configuration for a payroll administration
__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.
\n",
"summary": "Create a new journal configuration",
"operationId": "PostJournalConfigurationByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "journal configuration",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/journalConfigurationObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalConfigurationObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalConfigurations/{journalConfigurationId}": {
"get": {
"tags": [
"Journal configuration"
],
"description": "__Activity name:__ GetJournalConfigurationByJournalConfigurationId\n\nGet the details of a journal configuration\n",
"summary": "Details of a journal configuration",
"operationId": "GetJournalConfigurationByJournalConfigurationId",
"parameters": [
{
"$ref": "#/components/parameters/journalConfigurationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalConfigurationObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Journal configuration"
],
"description": "__Activity name:__ PutJournalConfigurationByJournalConfigurationId\n\nEdit the details of a journal configuration record\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n",
"summary": "Edit the details of a journal configuration",
"operationId": "PutJournalConfigurationByJournalConfigurationId",
"parameters": [
{
"$ref": "#/components/parameters/journalConfigurationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "journal configuration",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/journalConfigurationObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalConfigurationObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Journal configuration"
],
"description": "__Activity name:__ DeleteJournalConfigurationByJournalConfigurationId\n\nDelete a journal configuration\n",
"summary": "Delete a journal configuration",
"operationId": "DeleteJournalConfigurationByJournalConfigurationId",
"parameters": [
{
"$ref": "#/components/parameters/journalConfigurationId"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalConfigurations/{journalConfigurationId}/journalApplication": {
"get": {
"tags": [
"Journal application"
],
"description": "__Activity name:__ GetJournalApplicationByJournalConfigurationId \n\nGet the journal application for a journal configuration\n",
"summary": "Get the journal application for a journal configuration",
"operationId": "GetJournalApplicationByJournalConfigurationId",
"parameters": [
{
"$ref": "#/components/parameters/journalConfigurationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalApplicationObjectGetPut"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Journal application"
],
"description": "__Activity name:__ PostJournalApplicationByJournalConfigurationId
Create a new journal application for a journal configuration.
__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.
__Defaults :__ There is NO /defaults endpoint available for this resource.
\n",
"summary": "Create a new journal application for a journal configuration",
"operationId": "PostJournalApplicationByJournalConfigurationId",
"parameters": [
{
"$ref": "#/components/parameters/journalConfigurationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/journalApplicationObjectPost"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalApplicationObjectPost"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Journal application"
],
"description": "__Activity name:__ PatchJournalApplicationByJournalConfigurationId \n\nEdit the details of journal application\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n",
"summary": "Edit the details of a journal application",
"operationId": "PatchJournalApplicationByJournalConfigurationId",
"parameters": [
{
"$ref": "#/components/parameters/journalConfigurationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/journalApplicationObjectGetPut"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalApplicationObjectGetPut"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Journal application"
],
"description": "__Activity name:__ DeleteJournalApplicationByJournalConfigurationId \n\nDelete a journal application\n",
"summary": "Delete a journal application",
"operationId": "DeleteJournalApplicationByJournalConfigurationId",
"parameters": [
{
"$ref": "#/components/parameters/journalConfigurationId"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/journalProfiles": {
"get": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name :__ GetJournalProfilesByProviderId\n\nGet a list of all journal profiles for the given provider\n",
"summary": "List journal profiles for the given provider",
"operationId": "GetJournalProfilesByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/journalProfileProviderLevelObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name :__ PostJournalProfileAtProviderLevelByProviderId\n\n__Metadata :__ No metadata. For the list of journalprofiles that can be copied, see the GET endpoint `/journalProfiles`\n\n__Defaults :__ No defaults \n\nAdd a new journal profile for the provider.\n",
"summary": "Create a journal profile for the provider.",
"operationId": "PostJournalProfileAtProviderLevelByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a journal profile for a provider.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/journalProfilePostObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalProfileProviderLevelObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/journalProfiles/{journalProfileId}": {
"get": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name :__ GetJournalProfileAtProviderLevelByJournalProfileId\n\nGet the details of a journal profile\n",
"summary": "Details of a journal profile",
"operationId": "GetJournalProfileAtProviderLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalProfileProviderLevelObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name :__ PutJournalProfileAtProviderLevelByJournalProfileId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL. \n\nEdit the details of a journal profile\n",
"summary": "Edit the details of a journal profile",
"operationId": "PutJournalProfileAtProviderLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Journal profile to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/journalProfileProviderLevelObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalProfileProviderLevelObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name :__ DeleteJournalProfileAtProviderLevelByJournalProfileId\n\nDelete a journal profile\n",
"summary": "Delete a journal profile",
"operationId": "DeleteJournalProfileAtProviderLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/journalProfiles/{journalProfileId}/ledgerAccounts": {
"get": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ GetLedgerAccountsAtProviderLevelByJournalProfileId\n\nGet the list of ledger accounts for a journal profile of a specific provider.",
"summary": "List of ledger accounts for a journal profile of a specific provider.",
"operationId": "GetLedgerAccountsAtProviderLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ledgerAccountProviderLevelObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ PostLedgerAccountAtProviderLevelByJournalProfileId
Create a new ledger account for a journal profile.
__Metadata :__ No metadata
__Defaults :__ There is NO /defaults endpoint available for this resource.
\n",
"summary": "Create a new ledger account for a journal profile of a specific provider.",
"operationId": "PostLedgerAccountAtProviderLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "LedgerAccount",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/ledgerAccountProviderLevelObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ledgerAccountProviderLevelObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/journalProfiles/ledgerAccounts/{ledgerAccountId}": {
"get": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ GetLedgerAccountAtProviderLevelByLedgerAccountId\n\nGet the details of a ledger account at provider level \n",
"summary": "Details of a ledger account at provider level",
"operationId": "GetLedgerAccountAtProviderLevelByLedgerAccountId",
"parameters": [
{
"$ref": "#/components/parameters/ledgerAccountId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ledgerAccountProviderLevelObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ PatchLedgerAccountAtProviderLevelByLedgerAccountId\n\nEdit the details of a ledger account record (grootboekrekening)\n\n* No metadata required\n",
"summary": "Edit the details of a journal allocation record at the provider level",
"operationId": "PatchLedgerAccountAtProviderLevelByLedgerAccountId",
"parameters": [
{
"$ref": "#/components/parameters/ledgerAccountId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Ledger accounts",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/ledgerAccountProviderLevelObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ledgerAccountProviderLevelObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ DeleteLedgerAccountAtProviderLevelByLedgerAccountId\n\nDelete a ledger account on the provider level\n",
"summary": "Delete a ledger account on the provider level",
"operationId": "DeleteLedgerAccountAtProviderLevelByLedgerAccountId",
"parameters": [
{
"$ref": "#/components/parameters/ledgerAccountId"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/journalProfiles/{journalProfileId}/ledgerAccountToPayrollComponentLinks\"": {
"get": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ GetLedgerAccountToPayrollComponentLinksAtProviderLevelByJournalProfileId\n\nGet the list of ledger account to payroll component links (verdelingschema) for a journal profile at provider level.",
"summary": "List of ledger account to payroll component links at provider level",
"operationId": "GetLedgerAccountToPayrollComponentLinksAtProviderLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ledgerAccountToPayrollComponentLinkAtProviderLevelObjectGetAndPatch"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ PostLedgerAccountToPayrollComponentLinkAtProviderLevelByJournalProfileId
Create a new ledger account to payroll component link for a journal profile at provider level.\n",
"summary": "Create a new ledger account to payroll component link for a journal profile at provider level",
"operationId": "PostLedgerAccountToPayrollComponentLinkAtProviderLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "LedgerAccountToPayrollComponentLink",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/ledgerAccountToPayrollComponentLinkAtProviderLevelObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ledgerAccountToPayrollComponentLinkAtProviderLevelObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/journalProfiles/ledgerAccountToPayrollComponentLinks/{ledgerAccountToPayrollComponentLinkId}": {
"get": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ GetLedgerAccountToPayrollComponentLinkAtProviderLevelByLedgerAccountToPayrollComponentLinkId\n\nGet the details of a ledger account to payroll component link at provider level.",
"summary": "Details of a ledger account to payroll component link at provider level",
"operationId": "GetLedgerAccountToPayrollComponentLinkAtProviderLevelByLedgerAccountToPayrollComponentLinkId",
"parameters": [
{
"$ref": "#/components/parameters/ledgerAccountToPayrollComponentLinkId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ledgerAccountToPayrollComponentLinkAtProviderLevelObjectGetAndPatch"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ PatchLedgerAccountToPayrollComponentLinkAtProviderLevelByLedgerAccountToPayrollComponentLinkId
Edit the details of a ledger account to payroll component link record at provider level.\n",
"summary": "Edit the details of a ledger account to payroll component link record at provider level",
"operationId": "PatchLedgerAccountToPayrollComponentLinkAtProviderLevelByLedgerAccountToPayrollComponentLinkId",
"parameters": [
{
"$ref": "#/components/parameters/ledgerAccountToPayrollComponentLinkId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Ledger account to payroll component link",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/ledgerAccountToPayrollComponentLinkAtProviderLevelObjectGetAndPatch"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ledgerAccountToPayrollComponentLinkAtProviderLevelObjectGetAndPatch"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ DeleteLedgerAccountToPayrollComponentLinkAtProviderLevelByLedgerAccountToPayrollComponentLinkId
Delete a ledger account to payroll component link at provider level.\n",
"summary": "Delete a ledger account to payroll component link at provider level",
"operationId": "DeleteLedgerAccountToPayrollComponentLinkAtProviderLevelByLedgerAccountToPayrollComponentLinkId",
"parameters": [
{
"$ref": "#/components/parameters/ledgerAccountToPayrollComponentLinkId"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/journalProfiles/{journalProfileId}/costCenters": {
"get": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ GetCostCentersAtProviderLevelByJournalProfileId\n\nGet the list of cost centers for a journal profile at provider level.",
"summary": "List of cost centers at provider level",
"operationId": "GetCostCentersAtProviderLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/costCenterProviderLevelObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ PostCostCenterAtProviderLevelByJournalProfileId\n\nCreate a new cost center for a journal profile at provider level.",
"summary": "Create a new cost center for a journal profile at provider level",
"operationId": "PostCostCenterAtProviderLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "CostCenter",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/costCenterProviderLevelObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/costCenterProviderLevelObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/journalProfiles/costCenters/{costCenterId}": {
"get": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ GetCostCenterAtProviderLevelByCostCenterId\n\nGet the details of a cost center at provider level.",
"summary": "Details of a cost center at provider level",
"operationId": "GetCostCenterAtProviderLevelByCostCenterId",
"parameters": [
{
"$ref": "#/components/parameters/costCenterId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/costCenterProviderLevelObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ PatchCostCenterAtProviderLevelByCostCenterId\n\nEdit the details of a cost center at provider level.",
"summary": "Edit the details of a cost center at provider level",
"operationId": "PatchCostCenterAtProviderLevelByCostCenterId",
"parameters": [
{
"$ref": "#/components/parameters/costCenterId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "CostCenter",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/costCenterProviderLevelObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/costCenterProviderLevelObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ DeleteCostCenterAtProviderLevelByCostCenterId\n\nDelete a cost center at provider level.",
"summary": "Delete a cost center at provider level",
"operationId": "DeleteCostCenterAtProviderLevelByCostCenterId",
"parameters": [
{
"$ref": "#/components/parameters/costCenterId"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/journalProfiles/{journalProfileId}/costUnits": {
"get": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ GetCostUnitsAtProviderLevelByJournalProfileId\n\nGet the list of cost units for a journal profile at provider level.",
"summary": "List of cost units at provider level",
"operationId": "GetCostUnitsAtProviderLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/costUnitProviderLevelObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ PostCostUnitAtProviderLevelByJournalProfileId\n\nCreate a new cost unit for a journal profile at provider level.",
"summary": "Create a new cost unit for a journal profile at provider level",
"operationId": "PostCostUnitAtProviderLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "CostUnit",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/costUnitProviderLevelObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/costUnitProviderLevelObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/journalProfiles/costUnits/{costUnitId}": {
"get": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ GetCostUnitAtProviderLevelByCostUnitId\n\nGet the details of a cost unit at provider level.",
"summary": "Details of a cost unit at provider level",
"operationId": "GetCostUnitAtProviderLevelByCostUnitId",
"parameters": [
{
"$ref": "#/components/parameters/costUnitId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/costUnitProviderLevelObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ PatchCostUnitAtProviderLevelByCostUnitId\n\nEdit the details of a cost unit at provider level.",
"summary": "Edit the details of a cost unit at provider level",
"operationId": "PatchCostUnitAtProviderLevelByCostUnitId",
"parameters": [
{
"$ref": "#/components/parameters/costUnitId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "CostUnit",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/costUnitProviderLevelObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/costUnitProviderLevelObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ DeleteCostUnitAtProviderLevelByCostUnitId\n\nDelete a cost unit at provider level.",
"summary": "Delete a cost unit at provider level",
"operationId": "DeleteCostUnitAtProviderLevelByCostUnitId",
"parameters": [
{
"$ref": "#/components/parameters/costUnitId"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/journalprofiles/{journalProfileId}/CostCenterCostUnitMatrix": {
"get": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ GetCostCenterCostUnitMatrixAtProviderLevelByJournalProfileId \n\nGet the matrix of cost center and cost unit connections for a journal profile.\n",
"summary": "Cost center and cost unit matrix",
"operationId": "GetCostCenterCostUnitMatrixAtProviderLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/matrixObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Journal profile provider"
],
"description": "__Activity name:__ PatchCostCenterCostUnitMatrixAtProviderLevelByJournalProfileId\n\nEdit the links between cost center and cost units (koppeling kostenplaats en kostendrager)\n",
"summary": "Edit the links between cost center and cost units",
"operationId": "PatchCostCenterCostUnitMatrixAtProviderLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/matrixObject"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/matrixObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/journalProfiles": {
"get": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ GetJournalProfilesByPayrollAdministrationId\n\nGet the list of journal profiles for a payroll administration.\n",
"summary": "List of journal profiles",
"operationId": "GetJournalProfilesByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/journalProfileObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalProfiles/{journalProfileId}": {
"get": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ GetJournalProfileAtPayrollAdministrationLevelByJournalProfileId\n\nGet the details of a journal profile\n",
"summary": "Details of a journal profile",
"operationId": "GetJournalProfileAtPayrollAdministrationLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalProfileObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ PutJournalProfileAtPayrollAdministrationLevelByJournalProfileId\n\nEdit the details of a journal profile\n\n* No metadata required\n",
"summary": "Edit the details of a journal profile record",
"operationId": "PutJournalProfileAtPayrollAdministrationLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/journalProfileObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalProfileObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalProfiles/{journalProfileId}/ledgerAccounts": {
"get": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ GetLedgerAccountsAtPayrollAdministrationLevelByJournalProfileId
Get the list of ledger accounts for a journal profile for a specific payroll administration.
\n",
"summary": "List of ledger accounts",
"operationId": "GetLedgerAccountsAtPayrollAdministrationLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ledgerAccountObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ PostLedgerAccountAtPayrollAdministrationLevelByJournalProfileId
Create a new ledger account for a journal profile.
__Metadata :__ No metadata
__Defaults :__ There is NO /defaults endpoint available for this resource.
\n",
"summary": "Create a new ledger account for a journal profile",
"operationId": "PostLedgerAccountAtPayrollAdministrationLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "LedgerAccount",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/ledgerAccountObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ledgerAccountObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalProfiles/ledgerAccounts/{ledgerAccountId}": {
"get": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ GetLedgerAccountAtPayrollAdministrationLevelByLedgerAccountId\n\nGet the details of a ledger account\n",
"summary": "Details of a ledger account",
"operationId": "GetLedgerAccountAtPayrollAdministrationLevelByLedgerAccountId",
"parameters": [
{
"$ref": "#/components/parameters/ledgerAccountId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ledgerAccountObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ PatchLedgerAccountAtPayrollAdministrationLevelByLedgerAccountId\n\nEdit the details of a ledger account record (grootboekrekening)\n\n* No metadata required\n",
"summary": "Edit the details of a journal allocation record",
"operationId": "PatchLedgerAccountAtPayrollAdministrationLevelByLedgerAccountId",
"parameters": [
{
"$ref": "#/components/parameters/ledgerAccountId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Ledger accounts",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/ledgerAccountObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ledgerAccountObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ DeleteLedgerAccountAtPayrollAdministrationLevelByLedgerAccountId\n\nDelete a ledger account\n",
"summary": "Delete a ledger account",
"operationId": "DeleteLedgerAccountAtPayrollAdministrationLevelByLedgerAccountId",
"parameters": [
{
"$ref": "#/components/parameters/ledgerAccountId"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalProfiles/{journalProfileId}/ledgerAccountToPayrollComponentLinks": {
"get": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ GetLedgerAccountToPayrollComponentLinksAtPayrollAdministrationLevelByJournalProfileId
Get the list of ledger account to payroll component links (verdelingschema) for a journal profile for a specific payroll administration.
\n",
"summary": "List of ledger account to payroll component links",
"operationId": "GetLedgerAccountToPayrollComponentLinksAtPayrollAdministrationLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ledgerAccountToPayrollComponentLinkObjectGetAndPatch"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ PostLedgerAccountToPayrollComponentLinkAtPayrollAdministrationLevelByJournalProfileId
Create a new ledger account to payroll component link for a journal profile.
__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.
journalprofiles/{journalProfileId:guid}/ledgeraccounttopayrollcomponentlinks/metadata
__Defaults :__ There is NO /defaults endpoint available for this resource.
\n",
"summary": "Create a new ledger account to payroll component link for a journal profile",
"operationId": "PostLedgerAccountToPayrollComponentLinkAtPayrollAdministrationLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "LedgerAccountToPayrollComponentLink",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/ledgerAccountToPayrollComponentLinkObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ledgerAccountToPayrollComponentLinkObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalProfiles/{journalProfileId}/ledgerAccountToPayrollComponentLinks/metadata": {
"get": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ GetLedgerAccountToPayrollComponentLinkMetadataByJournalProfileId
Get the metadata of ledger account to payroll component links (verdelingschema) for a journal profile for a specific payroll administration.
\n",
"summary": "Metadata for ledger account to payroll component links",
"operationId": "GetLedgerAccountToPayrollComponentLinkMetadataByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ledgerAccountToPayrollComponentLinkObjectMetadata"
}
}
}
}
]
},
"examples": {
"defaults": {
"$ref": "#/components/examples/metadata-2"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalProfiles/ledgerAccountToPayrollComponentLinks/{ledgerAccountToPayrollComponentLinkId}": {
"get": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ GetLedgerAccountToPayrollComponentLinkAtPayrollAdministrationLevelByLedgerAccountToPayrollComponentLinkId
Get the details of a ledger account to payroll component link\n",
"summary": "Details of a ledger account to payroll component link",
"operationId": "GetLedgerAccountToPayrollComponentLinkAtPayrollAdministrationLevelByLedgerAccountToPayrollComponentLinkId",
"parameters": [
{
"$ref": "#/components/parameters/ledgerAccountToPayrollComponentLinkId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ledgerAccountToPayrollComponentLinkObjectGetAndPatch"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ PatchLedgerAccountToPayrollComponentLinkAtPayrollAdministrationLevelByLedgerAccountToPayrollComponentLinkId
Edit the details of a ledger account to payroll component link record (verdelingschema)
__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.
journalprofiles/ledgeraccounttopayrollcomponentlinks/{ledgerAccountToPayrollComponentLinkId:guid}/metadata\n",
"summary": "Edit the details of a ledger account to payroll component link record",
"operationId": "PatchLedgerAccountToPayrollComponentLinkAtPayrollAdministrationLevelByLedgerAccountToPayrollComponentLinkId",
"parameters": [
{
"$ref": "#/components/parameters/ledgerAccountToPayrollComponentLinkId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Ledger account to payroll component link",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/ledgerAccountToPayrollComponentLinkObjectGetAndPatch"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ledgerAccountToPayrollComponentLinkObjectGetAndPatch"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ DeleteLedgerAccountToPayrollComponentLinkAtPayrollAdministrationLevelByLedgerAccountToPayrollComponentLinkId
Delete a ledger account to payroll component link\n",
"summary": "Delete a ledger account to payroll component link",
"operationId": "DeleteLedgerAccountToPayrollComponentLinkAtPayrollAdministrationLevelByLedgerAccountToPayrollComponentLinkId",
"parameters": [
{
"$ref": "#/components/parameters/ledgerAccountToPayrollComponentLinkId"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalProfiles/{journalProfileId}/costCenters": {
"get": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ GetCostCentersAtPayrollAdministrationLevelByJournalProfileId\n\nGet the list of cost centers for a journal profile for a specific payroll administration.",
"summary": "List of cost centers",
"operationId": "GetCostCentersAtPayrollAdministrationLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/costCenterObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ PostCostCenterAtPayrollAdministrationLevelByJournalProfileId
Create a new cost center for a journal profile.
__Metadata :__ No metadata
__Defaults :__ There is NO /defaults endpoint available for this resource.
\n",
"summary": "Create a new cost center for a journal profile",
"operationId": "PostCostCenterAtPayrollAdministrationLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "CostCenter",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/costCenterObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/costCenterObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalProfiles/costCenters/{costCenterId}": {
"get": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ GetCostCenterAtPayrollAdministrationLevelByCostCenterId\n\nGet the details of a cost center\n",
"summary": "Details of a cost center",
"operationId": "GetCostCenterAtPayrollAdministrationLevelByCostCenterId",
"parameters": [
{
"$ref": "#/components/parameters/costCenterId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/costCenterObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ PatchCostCenterAtPayrollAdministrationLevelByCostCenterId\n\nEdit the details of a cost center record (kosten plaats)\n\n* No metadata required\n",
"summary": "Edit the details of a cost center",
"operationId": "PatchCostCenterAtPayrollAdministrationLevelByCostCenterId",
"parameters": [
{
"$ref": "#/components/parameters/costCenterId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Cost center",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/costCenterObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/costCenterObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ DeleteCostCenterAtPayrollAdministrationLevelByCostCenterId\n\nDelete a cost center\n",
"summary": "Delete a cost center",
"operationId": "DeleteCostCenterAtPayrollAdministrationLevelByCostCenterId",
"parameters": [
{
"$ref": "#/components/parameters/costCenterId"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalProfiles/{journalProfileId}/costUnits": {
"get": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ GetCostUnitsByJournalProfileId
Get the list of cost units for a journal profile for a specific payroll administration.
\n",
"summary": "List of cost units",
"operationId": "GetCostUnitsByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/costUnitObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ PostCostUnitByJournalProfileId
Create a new cost unit for a journal profile.
__Metadata :__ No metadata
__Defaults :__ There is NO /defaults endpoint available for this resource.
\n",
"summary": "Create a new cost unit for a journal profile",
"operationId": "PostCostUnitByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "CostUnit",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/costUnitObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/costUnitObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalProfiles/costUnits/{costUnitId}": {
"get": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ GetCostUnitByCostUnitId\n\nGet the details of a cost unit\n",
"summary": "Details of a cost unit",
"operationId": "GetCostUnitByCostUnitId",
"parameters": [
{
"$ref": "#/components/parameters/costUnitId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/costUnitObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ PatchCostUnitByCostUnitId\n\nEdit the details of a cost unit record (kosten drager)\n\n* No metadata required\n",
"summary": "Edit the details of a cost unit record",
"operationId": "PatchCostUnitByCostUnitId",
"parameters": [
{
"$ref": "#/components/parameters/costUnitId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Cost unit",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/costUnitObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/costUnitObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ DeleteCostUnitByCostUnitId\n\nDelete a cost unit\n",
"summary": "Delete a cost unit",
"operationId": "DeleteCostUnitByCostUnitId",
"parameters": [
{
"$ref": "#/components/parameters/costUnitId"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/journalProfiles/{journalProfileId}/CostCenterCostUnitMatrix": {
"get": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ GetCostCenterCostUnitMatrixAtPayrollAdministrationLevelByJournalProfileId
Get the matrix of cost centers and cost unit connections for a journal profile for a specific payroll administration.
\n",
"summary": "Cost centers and cost unit matrix",
"operationId": "GetCostCenterCostUnitMatrixAtPayrollAdministrationLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/matrixObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Journal profile payroll administration"
],
"description": "__Activity name:__ PatchCostCenterCostUnitMatrixAtPayrollAdministrationLevelByJournalProfileId\n\nEdit the links between cost centers and cost units (koppeling kostenplaats en kostendrager)\n",
"summary": "Edit the links between cost centers and cost units",
"operationId": "PatchCostCenterCostUnitMatrixAtPayrollAdministrationLevelByJournalProfileId",
"parameters": [
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/matrixObject"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/matrixObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/journalallocations": {
"get": {
"tags": [
"Journal allocation"
],
"description": "__Activity name:__ GetJournalAllocationsByEmploymentId
Get the list of financial journal allocations (journaliseren module) for an employment.
\n",
"summary": "List of journal allocations for an employment",
"operationId": "GetJournalAllocationsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/journalAllocationObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Journal allocation"
],
"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.
\n",
"summary": "Create a new journal allocation record for an employment",
"operationId": "PostJournalAllocationByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Journal allocation to add to the employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/journalAllocationObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalAllocationObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/journalallocations/{journalAllocationId}": {
"get": {
"tags": [
"Journal allocation"
],
"description": "__Activity name:__ GetJournalAllocationByJournalAllocationId\n\nGet the details of a financial journal allocation record (journaliseren module). \n",
"summary": "Details of a journal allocation",
"operationId": "GetJournalAllocationByJournalAllocationId",
"parameters": [
{
"$ref": "#/components/parameters/journalAllocationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalAllocationObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Journal allocation"
],
"description": "__Activity name:__ PutJournalAllocationByJournalAllocationId\n\nEdit the details of a financial journal allocation record (journaliseren module)\n\n* Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n* Possible options dependent on a specific `startPeriod` can be acquired via `/metadata/year/{year}/period/{period}`\n",
"summary": "Edit the details of a journal allocation record",
"operationId": "PutJournalAllocationByJournalAllocationId",
"parameters": [
{
"$ref": "#/components/parameters/journalAllocationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Organizational entity to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/journalAllocationObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/journalAllocationObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Journal allocation"
],
"description": "__Activity name:__ DeleteJournalAllocationByJournalAllocationId\n\nDelete a journal allocation record\n",
"summary": "Delete a specific journal allocation record",
"operationId": "DeleteJournalAllocationByJournalAllocationId",
"parameters": [
{
"$ref": "#/components/parameters/journalAllocationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/user": {
"get": {
"tags": [
"User"
],
"description": "__Activity name:__ GetUserByToken
Properties of the current user.
",
"summary": "Get current user",
"operationId": "GetUserByToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userSet"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/user/{userId}": {
"get": {
"tags": [
"User"
],
"description": "__Activity name:__ GetUserMinimizedByUserId
Basic properties of a user.
",
"summary": "Basic properties of a user",
"operationId": "GetUserByUserId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/userId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userMinimized"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"User"
],
"description": "__Activity name:__ PutUserByToken
Edit some of the properties of the current user. Metadata can be acquired by adding /metadata to the path.
",
"summary": "Edit current user",
"operationId": "PutUserByToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/userId"
}
],
"requestBody": {
"description": "User to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/userSet"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userSet"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/user/photo": {
"get": {
"tags": [
"User"
],
"description": "__Activity name :__ GetUserPhotoByToken\n\nPhoto of the user to use as an avatar/profile picture\n\n__Caching:__ This resource changes very infrequently and can be cached for a longer time.\n",
"summary": "Photo of an user",
"operationId": "GetUserPhotoByToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/jpg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"User"
],
"description": "__Activity name :__ PostUserPhotoByToken\n\nPhoto of the user to use as an avatar/profile picture\n",
"summary": "Post user photo",
"operationId": "PostUserPhotoByToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Logo to be uploaded for the user.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/logoPostObject"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"User"
],
"description": "__Activity name :__ DeleteUserPhotoByToken\n\nPhoto of the user to use as an avatar/profile picture\n",
"summary": "Delete user photo",
"operationId": "DeleteUserPhotoByToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/globalfilter/user/filtersettings/{employerId}": {
"get": {
"tags": [
"User filter settings"
],
"description": "__Activity name:__ GetUserFilterSettingsByEmployerId
__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.
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.
",
"summary": "Get user filter settings",
"operationId": "GetUserFilterSettingsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userSettings"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"User filter settings"
],
"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.
",
"summary": "Edit the user filter settings",
"operationId": "PutUserFilterSettingsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
}
],
"requestBody": {
"description": "Filters",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/userSettings"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userSettings"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/users": {
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/providerId"
}
],
"get": {
"tags": [
"Provider user"
],
"description": "__Activity name :__ GetProviderUsersByProviderId\n\n\n Get the list of users of the provider\n",
"summary": "List of provider users for an provider",
"operationId": "GetProviderUsersByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=SSO_gebruiker": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userGetAndPut"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Provider user"
],
"description": "__Activity name :__ PostProviderUserByProviderId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL. \n\nAdd an SSO or Azure AD user for an provider. \n",
"summary": "Create an SSO or Azure AD provider user for an provider",
"operationId": "PostProviderUserByProviderId",
"requestBody": {
"description": "Add a user for an provider.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/userPost"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userGetAndPut"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/users/{userId}": {
"get": {
"tags": [
"Provider user"
],
"description": "__Activity name :__ GetProviderUserByUserId\n\nGet the details of a provider user\n",
"summary": "Details of a provider user",
"operationId": "GetProviderUserByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userGetAndPut"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Provider user"
],
"description": "__Activity name :__ PutProviderUserByUserId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n\nEdit the details of a provider user\n",
"summary": "Edit the details of a provider user",
"operationId": "PutProviderUserByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "User to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/userGetAndPut"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userGetAndPut"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Provider user"
],
"description": "__Activity name :__ DeleteProviderUserByUserId\n\nDelete a provider user\n",
"summary": "Delete a specific provider user record",
"operationId": "DeleteProviderUserByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/users/{userId}/access": {
"patch": {
"tags": [
"Provider user"
],
"description": "__Activity name :__ PatchManageProviderUserLoketAccessByUserId\n\n__Metadata :__ No metadata\n\n__Defaults :__ No defaults\n\nReinstate or Revoke access to Loket. \n\nThis endpoint can also be used to block access to just the loket classic interface\n\n__Note:__ Only blocks access to \"Loket2\" and \"Loket3\" client. Conections for other clients are not affected by this action.\n",
"summary": "Reinstate or Revoke access to Loket for a provider user (clients)",
"operationId": "PatchManageProviderUserLoketAccessByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/manageLoketAccess"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userGetAndPut"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/users/invite": {
"post": {
"tags": [
"Provider user"
],
"description": "__Activity name :__ PostInviteProviderUserByProviderId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired via /v2/providers/providers/{providerId}/users/metadata\n\n__Defaults :__ Default values for a new object can be acquired by via /v2/providers/providers/{providerId}/users/defaults\n\nSend an invite to an user for an provider user. \n",
"summary": "Send an invite to a provider user",
"operationId": "PostInviteProviderUserByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Send an invite to a user",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/userInvite"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userGetAndPut"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/users/{userId}/invite": {
"patch": {
"tags": [
"Provider user"
],
"description": "__Activity name :__ PatchProviderUserInviteByUserId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired via /v2/providers/users/metadata\n\n__Defaults :__ No defaults\n\nResend or Revoke an invite for an provider user. \n",
"summary": "Resend or Revoke an invite for a provider user",
"operationId": "PatchProviderUserInviteByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/patchUserInvite"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userGetAndPut"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/users/{userId}/authorizations": {
"get": {
"tags": [
"Provider user authorizations"
],
"description": "__Activity name :__ GetProviderUserAuthorizationsByUserId\n\n\n List the available authorizations for the provider user\n",
"summary": "The authorizations for the provider user",
"operationId": "GetProviderUserAuthorizationsByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"$ref": "#/components/schemas/authorizations"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Provider user authorizations"
],
"summary": "Manage the Provider user authorizations",
"description": "__Activity name :__ PatchProviderUserAuthorizationsByUserId\n\nManage the Provider user authorizations and `authorizationSet`\n\n__Note:__ Currently the `authorizationSet` doesnt do anything in regard to which authorizations are enabled or disabled. It only functions as a guide to the GUI to visualize and save the authorizations linked to the `authorizationSet`\nOnly the authorizations with isEnabled set to true are saved all other authorizations will be disabled. There are two exceptions\n",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"operationId": "PatchProviderUserAuthorizationsByUserId",
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/authorization"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/users/{userId}/authorizationSet": {
"get": {
"tags": [
"Provider user authorizations"
],
"description": "__Activity name :__ GetProviderUserAuthorizationSetByUserId\n\n\n Get the authorization set for the provider user\n",
"summary": "The authorization set for the user for the Provider",
"operationId": "GetProviderUserAuthorizationSetByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/authorizationSet-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/users/{userId}/authorizationGroups": {
"parameters": [
{
"$ref": "#/components/parameters/userId"
}
],
"get": {
"tags": [
"Provider user authorization groups"
],
"description": "__Activity name :__ GetProviderUserAuthorizationGroupsByUserId\n\n\n List the available authorization groups for the provider user\n",
"summary": "The authorization groups for the provider user",
"operationId": "GetProviderUserAuthorizationGroupsByUserId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/authorizationGroup"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Provider user authorization groups"
],
"summary": "Manage the provider user authorization groups",
"description": "__Activity name :__ PatchProviderUserAuthorizationGroupsByUserId\n\nManage the provider user authorization groups\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"operationId": "PatchProviderUserAuthorizationGroupsByUserId",
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"example": [
"123e4567-e89b-12d3-a456-426614174000",
"321e4567-e89b-12d3-a456-426614174001"
],
"items": {
"type": "string",
"format": "uuid"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/users/{userId}/clients": {
"get": {
"tags": [
"User client"
],
"description": "__Activity name:__ GetProviderUserClientsByUserId
List of all the clients for the provider user
",
"summary": "List of all the clients for the provider user",
"operationId": "GetProviderUserClientsByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/client"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/authorizationgroups": {
"get": {
"tags": [
"Authorization group"
],
"description": "__Activity name :__ GetAuthorizationGroupsByProviderId\n\nGet a list of all authorization groups (teams) for the given provider\n",
"summary": "List authorization groups (teams) for the given provider",
"operationId": "GetAuthorizationGroupsByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/authorizationGroupObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Authorization group"
],
"description": "__Activity name :__ PostAuthorizationGroupByProviderId\n\n__Metadata :__ No metadata\n\n__Defaults :__ no defaults \n\nAdd a new authorization group (team) for the provider.\n",
"summary": "Create an authorization group (team) for the provider.",
"operationId": "PostAuthorizationGroupByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add an authorization group (team) for an provider.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/authorizationGroupObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/authorizationGroupObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/authorizationgroups/{authorizationGroupId}": {
"get": {
"tags": [
"Authorization group"
],
"description": "__Activity name :__ GetAuthorizationGroupByAuthorizationGroupId\n\nGet the details of an authorization group\n",
"summary": "Details of an authorization group",
"operationId": "GetAuthorizationGroupByAuthorizationGroupId",
"parameters": [
{
"$ref": "#/components/parameters/authorizationGroupId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/authorizationGroupObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Authorization group"
],
"description": "__Activity name :__ PutAuthorizationGroupByAuthorizationGroupId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n\nEdit the details of an authorization group\n",
"summary": "Edit the details of an authorization group",
"operationId": "PutAuthorizationGroupByAuthorizationGroupId",
"parameters": [
{
"$ref": "#/components/parameters/authorizationGroupId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Authorization group to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/authorizationGroupObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/authorizationGroupObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Authorization group"
],
"description": "__Activity name :__ DeleteAuthorizationGroupByAuthorizationGroupId\n\nDelete an authorization group\n",
"summary": "Delete an authorization group",
"operationId": "DeleteAuthorizationGroupByAuthorizationGroupId",
"parameters": [
{
"$ref": "#/components/parameters/authorizationGroupId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/authorizationgroups/{authorizationGroupId}/authorizations": {
"get": {
"tags": [
"Authorization group authorizations"
],
"description": "__Activity name :__ GetAuthorizationGroupAuthorizationsByAuthorizationGroupId\n\n\n List the authorizations for the authorization group. \n Note that if a provider user linked to the authorization group has authorizations configured on\n user level those authorizations overrule the authorization group.\n",
"summary": "The authorizations for the authorization group",
"operationId": "GetAuthorizationGroupAuthorizationsByAuthorizationGroupId",
"parameters": [
{
"$ref": "#/components/parameters/authorizationGroupId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"$ref": "#/components/schemas/authorizations"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Authorization group authorizations"
],
"description": "__Activity name :__ PatchAuthorizationGroupAuthorizationsByAuthorizationGroupId\n\nManage the authorization group authorizations and `authorizationSet`.\n\n__Note:__ Currently the `authorizationSet` doesnt do anything in regard to which authorizations are enabled or disabled. It only functions as a guide to the GUI to visualize and save the authorizations linked to the `authorizationSet`\nOnly the authorizations with isEnabled set to true are saved all other authorizations will be disabled.\n",
"summary": "Manage the authorization group authorizations",
"operationId": "PatchAuthorizationGroupAuthorizationsByAuthorizationGroupId",
"parameters": [
{
"$ref": "#/components/parameters/authorizationGroupId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/authorization"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/authorizationgroups/{authorizationGroupId}/employers": {
"get": {
"tags": [
"Authorization group employers"
],
"description": "__Activity name :__ GetAuthorizationGroupEmployersByAuthorizationGroupId\n\n\n List the employers for the authorization group. \n",
"summary": "The employers for the authorization group",
"operationId": "GetAuthorizationGroupEmployersByAuthorizationGroupId",
"parameters": [
{
"$ref": "#/components/parameters/authorizationGroupId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"$ref": "#/components/schemas/employersObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Authorization group employers"
],
"description": "__Activity name :__ PatchAuthorizationGroupEmployersByAuthorizationGroupId\n\nManage the employers linked to the authorization group.\nOnly the employers with isLinked set to true are saved all other employers will be disabled.\n",
"summary": "Manage the authorization group employers",
"operationId": "PatchAuthorizationGroupEmployersByAuthorizationGroupId",
"parameters": [
{
"$ref": "#/components/parameters/authorizationGroupId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employersObjectPatch"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/authorizationgroups/{authorizationGroupId}/users": {
"get": {
"tags": [
"Authorization group users"
],
"description": "__Activity name :__ GetAuthorizationGroupUsersByAuthorizationGroupId\n\n\n List the users for the authorization group. \n",
"summary": "The users for the authorization group",
"operationId": "GetAuthorizationGroupUsersByAuthorizationGroupId",
"parameters": [
{
"$ref": "#/components/parameters/authorizationGroupId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"$ref": "#/components/schemas/usersObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Authorization group users"
],
"description": "__Activity name :__ PatchAuthorizationGroupUsersByAuthorizationGroupId\n\nManage the users linked to the authorization group.\nOnly the users with isEnabled set to true are saved all other users will be disabled.\n",
"summary": "Manage the authorization group users",
"operationId": "PatchAuthorizationGroupUsersByAuthorizationGroupId",
"parameters": [
{
"$ref": "#/components/parameters/authorizationGroupId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"description": "An array of userId GUID that are to be linked to the authorization group. UserId that are not supplied will be unlinked.",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/userObjectPatch"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/employers/{employerId}/authorizationGroups": {
"get": {
"tags": [
"Employer authorization groups"
],
"description": "__Activity name :__ GetEmployerAuthorizationGroupsByProviderIdAndEmployerId\n\n\n List the authorization groups for the employer\n",
"summary": "The authorization groups for the employer",
"operationId": "GetEmployerAuthorizationGroupsByProviderIdAndEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/includeAddEmployerWizardInformation"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/authorizationGroupObject-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Employer authorization groups"
],
"description": "__Activity name :__ PatchEmployerAuthorizationGroupsByProviderIdAndEmployerId\n\nManage the authorization groups linked to the employer.\n",
"summary": "Manage the authorization groups linked to the employer",
"operationId": "PatchEmployerAuthorizationGroupsByProviderIdAndEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/authorizationGroupObjectPatch"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/users/integrations": {
"get": {
"tags": [
"User"
],
"description": "__Activity name:__ GetIntegrationsByBearerToken\n\nList of all the integrations for the logon user.\nThe difference between integrations and connected applications is as follows\n* integrations = from lokets point of view an incomming connection where a different application connects with the loket API\n* connected applications = from lokets point of view an outgoing connection where a loket connects with the API of a different application",
"summary": "List of all the integrations for the logon user",
"operationId": "GetIntegrationsByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/integration"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/users/{userId}/integrations": {
"get": {
"tags": [
"User"
],
"description": "__Activity name:__ GetEmployerUserIntegrationsByUserId\nList of all the integrations for the employer user",
"summary": "List of all the integrations for the employer user",
"operationId": "GetEmployerUserIntegrationsByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/integration"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/users/{userId}/integrations/{applicationId}": {
"put": {
"tags": [
"User"
],
"summary": "Change an integration",
"description": "__Activity name:__ PutEmployerUserIntegrationByUserIdAndApplicationId\n\nChange the integration\n",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/applicationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"operationId": "PutEmployerUserIntegrationByIntegrationId",
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/integration"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/integration"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"User"
],
"description": "__Activity name:__ DeleteEmployerUserIntegrationByUserIdAndApplicationId\n\nDelete an integration\n",
"summary": "Delete an integration",
"operationId": "DeleteEmployerUserIntegrationByUserIdAndApplicationId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/applicationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/users/{userId}/integrations/{applicationId}/logo": {
"get": {
"tags": [
"User"
],
"description": "__Activity name:__ GetEmployerUserIntegrationLogoByUserIdAndApplicationId\n\nThis activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.\n\n__Caching:__ This resource changes very infrequently and can be cached for a longer time.\n\nGet the logo of the application. In case no logo is know the service will return a 404.",
"summary": "Download the application logo",
"operationId": "GetEmployerUserIntegrationLogoByUserIdAndApplicationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/applicationId-2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/jpg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/users/{userId}/integrations": {
"parameters": [
{
"$ref": "#/components/parameters/userId"
}
],
"get": {
"tags": [
"User"
],
"description": "__Activity name:__ GetProviderUserIntegrationsByUserId\n\nList of all the integrations for the provider user",
"summary": "List of all the integrations for a provider user",
"operationId": "GetProviderUserIntegrationsByUserId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/integration"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/users/{userId}/integrations/{applicationId}": {
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/applicationId"
}
],
"put": {
"tags": [
"User"
],
"summary": "Change an integration for a provider user",
"description": "__Activity name:__ PutProviderUserIntegrationByUserIdAndApplicationId\n\nChange the integration\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"operationId": "PutProviderUserIntegrationByUserIdAndApplicationId",
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/integration"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/integration"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"User"
],
"description": "__Activity name:__ DeleteProviderUserIntegrationByUserIdAndApplicationId\n\nDelete an integration\n",
"summary": "Delete an integration for a provider user",
"operationId": "DeleteProviderUserIntegrationByUserIdAndApplicationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/users/{userId}/integrations/{applicationId}/logo": {
"get": {
"tags": [
"User"
],
"description": "__Activity name:__ GetProviderUserIntegrationLogoByUserIdAndApplicationId\n\nThis activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.\n\n__Caching:__ This resource changes very infrequently and can be cached for a longer time.\n\nGet the logo of the application. In case no logo is know the service will return a 404.",
"summary": "Download the application logo",
"operationId": "GetProviderUserIntegrationLogoByUserIdAndApplicationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/applicationId-2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/jpg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/users/clients": {
"get": {
"tags": [
"User"
],
"description": "__Activity name:__ GetClientsByBearerToken
List of all the clients for the logon user
",
"summary": "List of all the clients for the logon user",
"operationId": "GetClientsByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/client"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/users/{userId}/clients": {
"get": {
"tags": [
"User client"
],
"description": "__Activity name:__ GetEmployerUserClientsByUserId
List of all the clients for the employer user
",
"summary": "List of all the clients for the employer user",
"operationId": "GetEmployerUserClientsByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/client"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/users/connectedApplications": {
"get": {
"tags": [
"Connected applications"
],
"description": "__Activity name:__ GetConnectedApplicationsByBearerToken
List of all the connected applications for the logon user.
The difference between integrations and connected applications is as follows
* integrations = from lokets point of view an incomming connection where a different application connects with the loket API
* connected applications = from lokets point of view an outgoing connection where a loket connects with the API of a different application
",
"summary": "List of all the connected applications for the logon user",
"operationId": "GetConnectedApplicationsByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/connectedApplications"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Connected applications"
],
"description": "__Activity name :__ PatchConnectedApplicationByBearerToken\n\nThis endpoint will either create a new connected application or refresh the refresh_token for an existing connected application.\n",
"summary": "Finish the OAuth flow for a connected application",
"operationId": "PatchConnectedApplicationByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": false,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/connectedApplicationPatch"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/connectedApplications"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/users/connectedApplications/initiate": {
"patch": {
"tags": [
"Connected applications"
],
"description": "__Activity name :__ PatchInitiateConnectedApplicationByBearerToken\n\nA successfull call to this endpoint will return an OAuth URL that can be used to start the OAuth flow for the current user.\n",
"summary": "Initiate the OAuth flow to connect to an application",
"operationId": "PatchInitiateConnectedApplicationByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/connectedApplicationInitiateRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/connectedApplicationUrlResponse"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/users/connectedApplications/refresh": {
"patch": {
"tags": [
"Connected applications"
],
"description": "__Activity name :__ PatchRefreshConnectedApplicationByBearerToken\n\nA successful call to this endpoint will return an OAuth URL that can be used to the OAuth flow for the current user to refresh the existing connection.\n",
"summary": "Initiate the OAuth flow to refresh a connection for an application",
"operationId": "PatchRefreshConnectedApplicationByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/connectedApplicationRefreshRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/connectedApplicationUrlResponse"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/users/connectedApplications/{connectedApplicationId}": {
"delete": {
"tags": [
"Connected applications"
],
"description": "__Activity name:__ DeleteConnectedApplicationByConnectedApplicationId\n\nDelete a connected application\n",
"summary": "Delete a connected application",
"operationId": "DeleteConnectedApplicationByConnectedApplicationId",
"parameters": [
{
"$ref": "#/components/parameters/connectedApplicationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/users/{userId}/connectedApplications": {
"parameters": [
{
"$ref": "#/components/parameters/userId"
}
],
"get": {
"tags": [
"Connected applications"
],
"description": "__Activity name:__ GetConnectedApplicationsProviderUserByUserId\n\nList of all the connected applications for the logon user.\n\nThe difference between integrations and connected applications is as follows\n* integrations = from lokets point of view an incomming connection where a different application connects with the loket API\n* connected applications = from lokets point of view an outgoing connection where a loket connects with the API of a different application",
"summary": "List of all the connected applications for the logon user",
"operationId": "GetConnectedApplicationsProviderUserByUserId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/connectedApplications"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/users/{userId}/connectedApplications/initiate": {
"parameters": [
{
"$ref": "#/components/parameters/userId"
}
],
"patch": {
"tags": [
"Connected applications"
],
"description": "__Activity name:__ PatchInitiateConnectedApplicationProviderUserByUserId\n\nA successfull call to this endpoint will return an OAuth URL that can be used to start the OAuth flow for the current user.\n",
"summary": "Initiate the OAuth flow to connect to an application",
"operationId": "PatchInitiateConnectedApplicationProviderUserByUserId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/connectedApplicationInitiateRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/connectedApplicationUrlResponse"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/users/{userId}/connectedApplications/refresh": {
"parameters": [
{
"$ref": "#/components/parameters/userId"
}
],
"patch": {
"tags": [
"Connected applications"
],
"description": "__Activity name:__ PatchRefreshConnectedApplicationProviderUserByUserId\n\nA successful call to this endpoint will return an OAuth URL that can be used to the OAuth flow for the current user to refresh the existing connection.\n",
"summary": "Initiate the OAuth flow to refresh a connection for an application",
"operationId": "PatchRefreshConnectedApplicationProviderUserByUserId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/connectedApplicationRefreshRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/connectedApplicationUrlResponse"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/users/connectedApplications/{connectedApplicationId}": {
"parameters": [
{
"$ref": "#/components/parameters/connectedApplicationId"
}
],
"delete": {
"tags": [
"Connected applications"
],
"description": "__Activity name:__ DeleteConnectedApplicationProviderUserByConnectedApplicationId\n\nDelete a connected application\n",
"summary": "Delete a connected application",
"operationId": "DeleteConnectedApplicationProviderUserByConnectedApplicationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/users": {
"get": {
"tags": [
"Employer user"
],
"description": "__Activity name :__ GetEmployerUsersByEmployerId\n\n\n Get the list of users of the employer\n",
"summary": "List of users for an employer",
"operationId": "GetEmployerUsersByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=SSO_gebruiker": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userGetAndPut-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Employer user"
],
"description": "__Activity name :__ PostEmployerUserByEmployerId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL. \n\nAdd an SSO or Azure AD user for an employer. \n",
"summary": "Create an SSO or Azure AD user for an employer",
"operationId": "PostEmployerUserByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a user for an employer.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/userPost"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userGetAndPut-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/users/{userId}/access": {
"patch": {
"tags": [
"Employer user"
],
"description": "__Activity name :__ PatchManageEmployerUserLoketAccessByUserId\n\n__Metadata :__ No metadata\n\n__Defaults :__ No defaults\n\nReinstate or Revoke access to Loket. \n\nThis endpoint can also be used to block access to just the loket classic interface\n\n__Note:__ Only blocks access to \"Loket2\" en \"Loket3\" client. Conections for other clients are not affected by this action.\n",
"summary": "Reinstate or Revoke access to Loket for an employer user (clients)",
"operationId": "PatchManageEmployerUserLoketAccessByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/manageLoketAccess"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userGetAndPut-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/users/invite": {
"post": {
"tags": [
"Employer user"
],
"description": "__Activity name :__ PostInviteEmployerUserByEmployerId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired via /v2/providers/employers/{employerId}/users/metadata\n\n__Defaults :__ Default values for a new object can be acquired by via /v2/providers/employers/{employerId}/users/defaults\n\nSend an invite to an user for an employer user. \n",
"summary": "Send an invite to an email address to create an employer user",
"operationId": "PostInviteEmployerUserByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Send an invite to a user",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/userInvite"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userGetAndPut-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/users/{userId}/invite": {
"patch": {
"tags": [
"Employer user"
],
"description": "__Activity name :__ PatchEmployerUserInviteByUserId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired via /v2/providers/employers/{employerId}/users/metadata\n\n__Defaults :__ No defaults\n\nResend or Revoke an invite for an employer user. \n",
"summary": "Resend or Revoke an invite for an employer user",
"operationId": "PatchEmployerUserInviteByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/patchUserInvite-2"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userGetAndPut-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/users/{userId}": {
"get": {
"tags": [
"Employer user"
],
"description": "__Activity name :__ GetEmployerUserByUserId\n\nGet the details of an employer user\n",
"summary": "Details of an employer user",
"operationId": "GetEmployerUserByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userGetAndPut-2"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Employer user"
],
"description": "__Activity name :__ PutEmployerUserByUserId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n\nEdit the details of an employer user\n",
"summary": "Edit the details of an employer user user",
"operationId": "PutEmployerUserByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "User to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/userGetAndPut-2"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userGetAndPut-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Employer user"
],
"description": "__Activity name :__ DeleteEmployerUserByUserId\n\nDelete an employer user\n",
"summary": "Delete a specific employer user record",
"operationId": "DeleteEmployerUserByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/transferNotificationsTo"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/users/{userId}/informationForDelete": {
"get": {
"tags": [
"Employer user"
],
"description": "__Activity name :__ GetInformationForEmployerUserDeleteByEmployerIdAndUserId\n\nGet information about the user to determine if the user can be deleted or unlinked from the given employer.\n",
"summary": "Information about the employer user to determine if the user can be deleted",
"operationId": "GetInformationForEmployerUserDeleteByEmployerIdAndUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/deleteInformation"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/users/{userId}": {
"delete": {
"tags": [
"Employer user"
],
"description": "__Activity name :__ DeleteLinkBetweenEmployerUserAndEmployerByEmployerIdAndUserId\n\nDelete the link between an employer user and the given employer\n",
"summary": "unlink employer user and employer",
"operationId": "DeleteLinkBetweenEmployerUserAndEmployerByEmployerIdAndUserId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/transferNotificationsTo"
}
],
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/employers/users": {
"get": {
"tags": [
"Employer user"
],
"description": "__Activity name :__ GetEmployerUsersByProviderId\n\n\n Get the list of all employer users of the provider\n",
"summary": "List of all employer users for the provider",
"operationId": "GetEmployerUsersByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/allEmployerUsersForAProvider"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/users/{userId}/employers": {
"get": {
"tags": [
"Linked employers"
],
"description": "__Activity name :__ GetLinkedEmployersByUserId\n\n\n List of employers accessible by the user\n",
"summary": "List of employers linked to the user",
"operationId": "GetLinkedEmployersByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employerMinimized"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/users/departments": {
"get": {
"tags": [
"Linked departments"
],
"description": "__Activity name:__ GetEmployerUsersLinkedDepartmentsByEmployerId\n\nGet the list of departments that the user has access to\n",
"summary": "Get the list of departments that the user has access to",
"operationId": "GetEmployerUsersLinkedDepartmentsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/linkedDepartments"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/users/{userId}/departments": {
"patch": {
"tags": [
"Linked departments"
],
"description": "__Activity name:__ PatchEmployerUserLinkedDepartmentsByEmployerIdAndUserId\n\nThis endpoint enables the user to link or unlink multiple 'linkages' with one call.\n",
"summary": "Link or unlink departments from an user.",
"operationId": "PatchEmployerUserLinkedDepartmentsByEmployerIdAndUserId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "The request body",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/linkedDepartmentsPatch"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/users/{userId}/notificationsettings": {
"get": {
"tags": [
"Employer user notification settings"
],
"description": "__Activity name :__ GetEmployerUserNotificationSettingsByUserId \n\n\n List the configuration per notification for the user\n",
"summary": "The notification settings for the user",
"operationId": "GetEmployerUserNotificationSettingsByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"$ref": "#/components/schemas/notifications-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Employer user notification settings"
],
"summary": "Manage the employer user notification settings",
"description": "__Activity name :__ PatchEmployerUserNotificationSettingsByUserId\n\nManage the employer user notifications and `notificationSet`.\n\n__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`\n\nOnly 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.\n",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"operationId": "PatchEmployerUserNotificationSettingsByUserId",
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/notification-2"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/users/{userId}/notificationset": {
"get": {
"tags": [
"Employer user notification settings"
],
"description": "__Activity name :__ GetEmployerUserNotificationSetByUserId \n\n\n The configured notification set for the user\n",
"summary": "The notification set for the user",
"operationId": "GetEmployerUserNotificationSetByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/notificationSet"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/users/{userId}/authorizations": {
"get": {
"tags": [
"Employer user authorizations"
],
"description": "__Activity name :__ GetEmployerUserAuthorizationsByEmployerIdAndUserId\n\n\n List the available authorizations for the user - employer combination. Note that the employer user can have a different set of authorizations per employer.\n",
"summary": "The authorizations for the user",
"operationId": "GetEmployerUserAuthorizationsByEmployerIdAndUserId",
"parameters": [
{
"$ref": "#/components/parameters/employerId-3"
},
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"$ref": "#/components/schemas/authorizations"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Employer user authorizations"
],
"summary": "Manage the employer user authorizations",
"description": "__Activity name :__ PatchEmployerUserAuthorizationsByEmployerIdAndUserId\n\nManage the employer user authorizations and `authorizationSet`.\n\n__Note:__ Currently the `authorizationSet` doesnt do anything in regard to which authorizations are enabled or disabled. It only functions as a guide to the GUI to visualize and save the authorizations linked to the `authorizationSet`\nOnly the authorizations with isEnabled set to true are saved all other authorizations will be disabled.\n",
"parameters": [
{
"$ref": "#/components/parameters/employerId-3"
},
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"operationId": "PatchEmployerUserAuthorizationsByEmployerIdAndUserId",
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/authorization"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/users/{userId}/authorizationSet": {
"get": {
"tags": [
"Employer user authorizations"
],
"description": "__Activity name :__ GetEmployerUserAuthorizationSetByEmployerIdAndUserId\n\n\n Get the authorization set for the user - employer combination. Note that the employer user can have a different set of authorizations per employer.\n",
"summary": "The authorization set for the user for the employer",
"operationId": "GetEmployerUserAuthorizationSetByEmployerIdAndUserId",
"parameters": [
{
"$ref": "#/components/parameters/employerId-3"
},
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/authorizationSet-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/users/link": {
"post": {
"tags": [
"Employer user"
],
"description": "__Activity name :__ PostLinkExistingEmployerUserByEmployerId\n\n__Metadata :__ No metadata endpoint\n\n__Defaults :__ No default values\n\nLink an existing employer user to this employer. \n",
"summary": "Link an existing employer user to this employer.",
"operationId": "PostLinkExistingEmployerUserByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Link an existing user to this employer.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/linkExistingUser"
}
}
}
},
"responses": {
"200": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userGetAndPut-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/recommendedactions": {
"get": {
"tags": [
"Recommended actions"
],
"description": "__Activity name :__ GetRecommendedActionsByEmployerId\n\n\n Get the list of recommended actions of the employer, per logged on user\n",
"summary": "List of recommended actions for an employer, per logged on user",
"operationId": "GetRecommendedActionsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=SSO_gebruiker": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recommendedActionsGetAndPut"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/users/{userId}/employee": {
"get": {
"tags": [
"Linked employee"
],
"description": "__Activity name:__ GetEmployerUserLinkedEmployeeByEmployerIdAndUserId\n\nGet the employee that is linked to the user.\n",
"summary": "Get the Employee linked to the user.",
"operationId": "GetEmployerUserLinkedEmployeeByEmployerIdAndUserId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employeeBasic"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Linked employee"
],
"description": "__Activity name:__ PatchEmployerUserLinkedEmployeeByEmployerIdAndUserId\n\nThis endpoint enables the user to link or unlink an employee. Leave the employeeId empty to unlink the employee from the user.\n",
"summary": "Link or unlink Employee from an user.",
"operationId": "PatchEmployerUserLinkedEmployeeByEmployerIdAndUserId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/linkedEmployeePatch"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/userResponsibilities": {
"get": {
"tags": [
"User responsibility"
],
"description": "__Activity name :__ GetUserResponsibilitiesByProviderId\n\nGet the list of user responsibilities for the provider\n",
"summary": "List of user responsibilities for the provider",
"operationId": "GetUserResponsibilitiesByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userResponsibility"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"User responsibility"
],
"description": "__Activity name :__ PostUserResponsibilityByProviderId \n\nCreate a new user responsibility record for the given provider\n\n__Metadata :__ No metadata\n\n__Defaults :__ No defaults\n",
"summary": "Create an user responsibility for a provider",
"operationId": "PostUserResponsibilityByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "User responsibility",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/userResponsibility"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userResponsibility"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/userResponsibilities/{userResponsibilityId}": {
"put": {
"tags": [
"User responsibility"
],
"description": "__Activity name :__ PutUserResponsibilityByProviderIdAndUserResponsibilityId\n\nEdit the details of an user responsibility\n\n__Metadata :__ No metadata\n",
"summary": "Edit an user responsibility",
"operationId": "PutUserResponsibilityByProviderIdAndUserResponsibilityId",
"parameters": [
{
"$ref": "#/components/parameters/userResponsibilityId"
},
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "User responsibility to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/userResponsibility"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/userResponsibility"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/userResponsibilities": {
"get": {
"tags": [
"User responsibility"
],
"description": "__Activity name :__ GetUserResponsibilitiesByEmployerId\n\nGet the list of user responsibilities for the employer\n",
"summary": "List of user responsibilities for the employer",
"operationId": "GetUserResponsibilitiesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userResponsibility-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/userResponsibilities/{userResponsibilityId}/users": {
"get": {
"tags": [
"User responsibility"
],
"description": "__Activity name :__ GetLinkedUsersByEmployerIdAndUserResponsibilityId\n\nGet the list of all employer users and if they are linked to the user responsibility for the given employer or not\n",
"summary": "List of employer users and their linked status to the user responsibility for the given employer",
"operationId": "GetLinkedUsersByEmployerIdAndUserResponsibilityId",
"parameters": [
{
"$ref": "#/components/parameters/userResponsibilityId-2"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"$ref": "#/components/schemas/linkedUsers"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"User responsibility"
],
"summary": "Manage the users linked to the user responsibility",
"description": "__Activity name :__ PatchLinkedUsersByEmployerIdAndUserResponsibilityId\n\nManage the users linked to the user responsibility for the employer\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/userResponsibilityId-2"
},
{
"$ref": "#/components/parameters/employerId"
}
],
"operationId": "PatchLinkedUsersByEmployerIdAndUserResponsibilityId",
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/linkedUsersPatch"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/users/{userId}/userResponsibilities": {
"get": {
"tags": [
"User responsibility"
],
"description": "__Activity name :__ GetUserResponsibilitiesByEmployerIdAndUserId\n\nGet the list of responsibilities for the user\n",
"summary": "List of responsibilities for the user",
"operationId": "GetUserResponsibilitiesByEmployerIdAndUserId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userResponsibility-3"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"User responsibility"
],
"summary": "Manage the responsibilities linked to the user",
"description": "__Activity name :__ PatchUserResponsibilitiesByEmployerIdAndUserId\n\nManage the responsibility linked to the user\n",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"operationId": "PatchUserResponsibilitiesByEmployerIdAndUserId",
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/linkedResponsibilities"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/dashboardLicenses": {
"get": {
"tags": [
"Dashboard licenses"
],
"description": "__Activity name :__ GetDashboardLicensesByEmployerId\n\n\n Get the list dashboard licenses\n",
"summary": "Get the list dashboard licenses",
"operationId": "GetDashboardLicensesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/licenses"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Dashboard licenses"
],
"description": "__Activity name:__ PutDashboardLicensesByEmployerId\n\nEdit the dashboard licenses\n\n__Metadata :__ There is no metadata endpoint for this resource.\n",
"summary": "Edit the dashboard license",
"operationId": "PutDashboardLicensesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Edit dashboard users",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/licenses"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/licenses"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/externaltenants": {
"get": {
"tags": [
"External tenant"
],
"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.
",
"summary": "Get available external tenants (provider scope)",
"operationId": "GetExternalTenantsByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/externalTenantObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/externaltenants": {
"get": {
"tags": [
"External tenant"
],
"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.
",
"summary": "Get available external tenants (employer scope)",
"operationId": "GetExternalTenantsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/externalTenantObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/users/{providerUserId}/configuredexternaltenant": {
"get": {
"tags": [
"External tenant provider user"
],
"description": "__Activity name :__ GetConfiguredExternalTenantByProviderUserId\n\n\n Get the external tenant that is configured for this specific user. \n",
"summary": "Configured external tenant for a provider user",
"operationId": "GetConfiguredExternalTenantByProviderUserId",
"parameters": [
{
"$ref": "#/components/parameters/providerUserId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/configuredExternalTenantObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"External tenant provider user"
],
"description": "__Activity name :__ PatchConfiguredExternalTenantByProviderUserId\n\n__Metadata :__ N/A.\n\n__Defaults :__ N/A.\n\nModify an external tenant to the list of an configured external tenants for an employer user.\nAn configured external tenant may be removed by sending a request body with both an empty externalTenant object and an empty externalUser object.\n",
"summary": "Add an external tenant for a provider user",
"operationId": "PatchConfiguredExternalTenantByProviderUserId",
"parameters": [
{
"$ref": "#/components/parameters/providerUserId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add an external tenant for a provider user.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/configuredExternalTenantObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/configuredExternalTenantObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/users/{employerUserId}/configuredexternaltenant": {
"get": {
"tags": [
"External tenant employer user"
],
"description": "__Activity name :__ GetConfiguredExternalTenantByEmployerUserId\n\n\n Get the external tenant that is configured for this specific user. \n",
"summary": "Configured external tenant for an employer user",
"operationId": "GetConfiguredExternalTenantByEmployerUserId",
"parameters": [
{
"$ref": "#/components/parameters/employerUserId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/configuredExternalTenantObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"External tenant employer user"
],
"description": "__Activity name :__ PatchConfiguredExternalTenantByEmployerUserId\n\n__Metadata :__ N/A.\n\n__Defaults :__ N/A.\n\nModify an external tenant to the list of an configured external tenants for an employer user.\nAn configured external tenant may be removed by sending a request body with both an empty externalTenant object and an empty externalUser object.\n",
"summary": "Add an external tenant for an employer user",
"operationId": "PatchConfiguredExternalTenantByEmployerUserId",
"parameters": [
{
"$ref": "#/components/parameters/employerUserId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add an external tenant for an employer user.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/configuredExternalTenantObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/configuredExternalTenantObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/payslips": {
"get": {
"tags": [
"Payslip"
],
"description": "__Activity name :__ GetPayslipsByEmploymentId\n\n__Availability:__ This is endpoint is available for the Loket application only. It is not available for external parties\n\nGet a list of payslips for the specified employment, including the GUID of the corresponding payroll run.\n\nThe function of this endpoint is dependent on the role of the user;\n* 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) .\n* For users with any other role (in most cases); the endpoin returns results for approved payrollruns irregardless of the ESS date.\n",
"summary": "List of payslips for an employment",
"operationId": "GetPayslipsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payslip-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/payslips/{year}": {
"get": {
"tags": [
"Payslip"
],
"description": "__Activity name :__ GetPayslipsByEmploymentIdAndYear\n\n__Availability:__ This is endpoint is available for the Loket application only. It is not available for external parties\n\nDownload the payslips for a payroll year in a single PDF\n\n__Metadata :__ Possible options for `year` can be acquired (GET) the following URL /v2/providers/employers/employees/employments/{employmentId}/payslips/metadata.\n",
"summary": "Download payslips for an employment and year",
"operationId": "GetPayslipsByEmploymentIdAndYear",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/year"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/payslips/{payrollrunId}": {
"get": {
"tags": [
"Payslip"
],
"description": "__Activity name :__ GetPayslipsByEmploymentIdAndPayrollRunId\n\n__Availability:__ This is endpoint is available for the Loket application only. It is not available for external parties\n\nDownload the payslips or its underlying payroll results of an employment for the specified payrollrun\n\n**Please note: this endpoint has two types of output:**\n* the payslip(s) as a single PDF-file\n* the underlying payroll result data for the payslip(s) in JSON-format \n\nThis may be specified by providing the desired format in the `Accept` header of your request.\n",
"summary": "Download payslips of an employment for a payrollrun",
"operationId": "GetPayslipsByEmploymentIdAndPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/payrollrunId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employments"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/payrollperiodresults/year/{year}": {
"get": {
"tags": [
"Payslip"
],
"description": "__Activity name :__ GetPayrollPeriodResultsByEmploymentIdAndYear\n\nDownload the payroll results (conform overzicht strook) of an employment per payroll period for the provided year.\n\n**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)\n\n* Requesting payslips/results per RUN will provide you all payroll results from that specific payrollrun regardless of the period it applies to.\n* Requesting PERIOD results will provide you all (approved) payroll results for that period regardless of the payroll run it comes from.\n\nDe facto the payslips/results per RUN are your actual payslips (loonstrook). The results per period are more useful as an overview per period (overzichtstrook).\n\nOne 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.\n",
"summary": "Get payroll period results of an employment for a year",
"operationId": "GetPayrollPeriodResultsByEmploymentIdAndYear",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/year"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employments-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/payslips/summary/{payrollPeriodId}": {
"get": {
"tags": [
"Payslip"
],
"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 /v2/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
\n",
"summary": "Download a cummulative payslip for a single payroll period",
"operationId": "GetPayrollPeriodSummaryByEmploymentIdAndPayrollPeriodId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/payrollPeriodId-4"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/wagesheet/{year}": {
"get": {
"tags": [
"Payslip"
],
"description": "__Activity name :__ GetWageSheetByEmploymentIdAndYear\n\nDownload the wagesheet (loonstaat) for a payroll year\n\n__Metadata :__ Possible options for `year` can be acquired (GET) the following URL /v2/providers/employers/employees/employments/{employmentId}/wagesheet/metadata.\n\nReturns the wage sheets for an employment\n",
"summary": "Download wage sheets for an employment",
"operationId": "GetWageSheetByEmploymentIdAndYear",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/year"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/yearendstatements": {
"get": {
"tags": [
"Year-end statement"
],
"description": "__Activity name :__ GetYearEndStatementsByEmploymentId\n\nGet a list of year-end statements (i.e. list of years for which year-end statements are available) for an employment\n",
"summary": "Year-end statements for the employment",
"operationId": "GetYearEndStatementsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/yearEndStatement"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/yearendstatements/{year}": {
"get": {
"tags": [
"Year-end statement"
],
"description": "__Activity name :__ GetYearEndStatementForYearByEmploymentId\n\n__Availability:__ This is endpoint is available for the Loket application only. It is not available for external parties\n\n\nDownload the year-end statement of an employment for a year.\n",
"summary": "Download year-end statement of an employment for a year",
"operationId": "GetYearEndStatementForYearByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/year"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/yearendstatements": {
"get": {
"tags": [
"Year-end statement at administration level"
],
"description": "__Activity name :__ GetYearEndStatementsByPayrollAdministrationId\n\nGet a list of year-end statements (i.e. list of years for which year-end statements are available) for a payrolladministration.\n\nThe 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.\n",
"summary": "Year-end statements for the payroll administration",
"operationId": "GetYearEndStatementsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/yearEndStatement"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/yearendstatements/{year}": {
"get": {
"tags": [
"Year-end statement at administration level"
],
"description": "__Activity name :__ GetYearEndStatementForYearByPayrollAdministrationId\n\n__Availability:__ This is endpoint is available for the Loket application only. It is not available for external parties\n\nDownload the year-end statements of a payroll administration (of its underlying employment) for a year.\n\nThe 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.\n\n_Please note: this endpoint may only be used to acquire a report in the pdf-type format_ \n",
"summary": "Download year-end statement of a payroll administration for a year",
"operationId": "GetYearEndStatementForYearByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/year"
},
{
"$ref": "#/components/parameters/includeEmployeeSelfServiceNotRequired"
},
{
"$ref": "#/components/parameters/includeEmploymentsWithMijnLoketAccess"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrolltaxreturns": {
"get": {
"tags": [
"Payroll tax return"
],
"description": "__Activity name :__ GetPayrollTaxReturnsByPayrollAdministrationId\n\nA list of tax returns for an administration\n",
"summary": "List of tax returns for an administration",
"operationId": "GetPayrollTaxReturnsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollTaxReturn"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrolltaxreturns": {
"patch": {
"tags": [
"Payroll tax return"
],
"summary": "Change the status of payroll tax returns",
"description": "__Activity name :__ PatchPayrollTaxReturnsByPayrollTaxReturnIds\n\nThis endpoints changes the status of the list of the payroll tax returns provided in the request body based on the provided action.\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"operationId": "PatchPayrollTaxReturnsByPayrollTaxReturnIds",
"requestBody": {
"description": "The request body contains an array of objects containing a `PayrolTaxReturnId` and a `taxReturnMessageStatus`\n",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollTaxReturnPatch"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrolltaxreturns/{payrolltaxreturnId}/overview": {
"get": {
"tags": [
"Payroll tax return downloads"
],
"summary": "Download the overview report of a payroll tax return",
"description": "__Activity name :__ GetOverviewByPayrollTaxReturnId\n\nDownload the payroll tax return overiew\n\n__Deprecated :__ This endpoint has a new version as of 2025-08-01. The current version will be obsolete. \n\n__[New version](./#tag/Reports-new-style/operation/GetPayrollTaxReturnReportByPayrollTaxreturnId)__\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrolltaxreturnId"
}
],
"operationId": "GetOverviewByPayrollTaxReturnId",
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrolltaxreturns/{payrolltaxreturnId}/message": {
"get": {
"tags": [
"Payroll tax return downloads"
],
"summary": "Download the message of a payroll tax return",
"description": "__Activity name :__ GetMessageByPayrollTaxReturnId \n\nDownload 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.\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrolltaxreturnId"
}
],
"operationId": "GetMessageByPayrollTaxReturnId",
"responses": {
"200": {
"description": "OK",
"content": {
"application/xml": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrolltaxreturns/{payrolltaxreturnId}/sepafile": {
"get": {
"tags": [
"Payroll tax return downloads"
],
"summary": "Download the SEPA file for a payroll tax return",
"description": "__Activity name :__ GetSepaFileByPayrollAdministrationIdAndPayrollTaxReturnId\n\nGet the Sepa file for the payroll tax return\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/payrolltaxreturnId"
},
{
"name": "requestedExecutionDate",
"in": "query",
"description": "This value is used when creating the sepa file to set the value of \\",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"operationId": "GetSepaFileByPayrollAdministrationIdAndPayrollTaxReturnId",
"responses": {
"200": {
"description": "OK",
"content": {
"application/xml": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"headers": {
"Content-Disposition": {
"description": "The filename\n",
"schema": {
"type": "string",
"example": "inline; filename=\"SEPA001111111110L29000076201901.xml\""
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrolltaxreturns/{payrolltaxreturnId}/sepahash": {
"get": {
"tags": [
"Payroll tax return downloads"
],
"description": "__Activity name :__ GetSepaHashByPayrollTaxReturnId\n\nReturns the hash for the last created SEPA file for the specified payroll taxreturn. The hash is used to verify the integrity of the SEPA file. If no sepa file has been created, there will be no hash available.",
"summary": "Get a SEPA hash for a payroll tax return",
"operationId": "GetSepaHashByPayrollTaxReturnId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrolltaxreturnId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/sepaHash"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrolltaxreturns/{payrolltaxreturnId}": {
"get": {
"tags": [
"Payroll tax return"
],
"description": "__Activity name :__ GetPayrollTaxReturnByPayrollTaxReturnId\n\nThe details of a tax return for an administration\n",
"summary": "Details of a tax return for an administration",
"operationId": "GetPayrollTaxReturnByPayrollTaxReturnId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrolltaxreturnId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payrollTaxReturn"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrolltaxreturns/{payrolltaxreturnId}/ideal": {
"get": {
"tags": [
"Payroll tax return"
],
"description": "__Activity name :__ GetIdealUrlByPayrollTaxReturnId\n\nGet URL which allows the user to pay payroll taxes via IDEAL\n",
"summary": "Pay payroll taxes using IDEAL",
"operationId": "GetIdealUrlByPayrollTaxReturnId",
"parameters": [
{
"$ref": "#/components/parameters/payrolltaxreturnId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/idealLink"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrolltaxreturns/{payrolltaxreturnId}/idealPaymentStatus": {
"get": {
"tags": [
"Payroll tax return"
],
"description": "__Activity name :__ GetIdealPaymentStatusByPayrollTaxReturnId\n\nGet the status of the IDEAL payment\n",
"summary": "Get the status of the IDEAL payment",
"operationId": "GetIdealPaymentStatusByPayrollTaxReturnId",
"parameters": [
{
"$ref": "#/components/parameters/payrolltaxreturnId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/idealStatus"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrolltaxreturns/{payrolltaxreturnId}/report": {
"servers": [
{
"url": "https://api.loket.nl/payrolltaxreturn",
"description": "Production server Payroll Tax Return Microservice"
}
],
"get": {
"tags": [
"Payroll tax return downloads"
],
"description": "__Activity name :__ GetPayrollTaxreturnReportByPayrollTaxreturnId\n\nReturns the payroll taxreturn pdf report\n",
"summary": "Get payroll tax return report",
"operationId": "GetPayrollTaxreturnReportByPayrollTaxreturnId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrolltaxreturnId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrolltaxreturns/{payrolltaxreturnId}/sendresponsemessage": {
"post": {
"tags": [
"Payroll tax return response message"
],
"description": "__Activity name :__ PostSendResponseMessageByPayrollTaxReturnId\n\nSend the response message of the payroll tax return (loonaangifte) that was received from the Belastingdienst, to Loket. \nThis 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.\n\nWhat this endpoint does is the following:\n* 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\n* A set of input validations will be performed.\n* If those steps are successful 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\n* In other words; the result of this action will NOT be immediately visible\n",
"summary": "Send the response message for the payroll tax return",
"operationId": "PostSendResponseMessageByPayrollTaxReturnId",
"parameters": [
{
"$ref": "#/components/parameters/payrolltaxreturnId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "The request body contains the xml response message",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"responseMessageFile": {
"type": "string",
"example": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iSVNPLTg4NTktMSI/Pgo8UmVzcG9uc2VtZXNzYWdlIHZlcnNpb249IjIwMDYuMSI+Cgk8SWRlbnRpZmljYXRpb24+CgkJPE1lc3NhZ2VJZD5BLWVmMmJmMTQwMjMxYzExZTA4MWM5MGE5ZTA0MGIxMjM0PC9NZXNzYWdlSWQ+CgkJPFJlZmVyc1RvTWVzc2FnZUlkPlZTUDAwMTAwMTE4MzcyMkwwNDAwMDAwMTIwMTIzNDwvUmVmZXJzVG9NZXNzYWdlSWQ+CgkJPE1lc3NhZ2VJZEJkPmVmMmJmMTQwMjMxYzExZTA4MWM5MGE5ZTA0MGIxMjM0PC9NZXNzYWdlSWRCZD4KCQk8RGF0dW1UaWpkT250dmFuZ3N0PjIwMjAtMDEtMThUMTY6MDY6MzlaPC9EYXR1bVRpamRPbnR2YW5nc3Q+CgkJPFJlc3BvbnNlVHlwZT5hY2tub3dsZWRnZW1lbnQ8L1Jlc3BvbnNlVHlwZT4KCTwvSWRlbnRpZmljYXRpb24+CjwvUmVzcG9uc2VtZXNzYWdlPgo",
"description": "base64 encoded xml file of the response message",
"readOnly": false
}
}
}
}
}
},
"responses": {
"202": {
"description": "OK"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrolltaxreturns/{messageReference}": {
"patch": {
"tags": [
"Payroll tax return by message reference"
],
"summary": "Change the status of payroll tax returns",
"description": "__Activity name :__ PatchPayrollTaxReturnByMessageReference\n\nThis endpoints changes the status of the payroll tax returns provided in the path parameters based on the provided action.\n\nFunctionally, 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. \n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/messageReference"
}
],
"operationId": "PatchPayrollTaxReturnByMessageReference",
"requestBody": {
"description": "The request body contains an action\n",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/payrollTaxReturnSinglePatch"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrolltaxreturns/{messageReference}/sendresponsemessagebymessagereference": {
"post": {
"tags": [
"Payroll tax return by message reference"
],
"description": "__Activity name :__ PostSendResponseMessageByMessageReference\n\nThis endpoint is identical to PostSendResponseMessageByPayrollTaxReturnId endpoint, however this endpoint takes the messageReference (NL: BERICHTKENMERK) as path id. Instead of payrollTaxReturnId (GUID). \n",
"summary": "Send the response message for the payroll tax return",
"operationId": "PostSendResponseMessageByMessageReference",
"parameters": [
{
"$ref": "#/components/parameters/messageReference"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "The request body contains the xml response message",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"responseMessageFile": {
"type": "string",
"example": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iSVNPLTg4NTktMSI/Pgo8UmVzcG9uc2VtZXNzYWdlIHZlcnNpb249IjIwMDYuMSI+Cgk8SWRlbnRpZmljYXRpb24+CgkJPE1lc3NhZ2VJZD5BLWVmMmJmMTQwMjMxYzExZTA4MWM5MGE5ZTA0MGIxMjM0PC9NZXNzYWdlSWQ+CgkJPFJlZmVyc1RvTWVzc2FnZUlkPlZTUDAwMTAwMTE4MzcyMkwwNDAwMDAwMTIwMTIzNDwvUmVmZXJzVG9NZXNzYWdlSWQ+CgkJPE1lc3NhZ2VJZEJkPmVmMmJmMTQwMjMxYzExZTA4MWM5MGE5ZTA0MGIxMjM0PC9NZXNzYWdlSWRCZD4KCQk8RGF0dW1UaWpkT250dmFuZ3N0PjIwMjAtMDEtMThUMTY6MDY6MzlaPC9EYXR1bVRpamRPbnR2YW5nc3Q+CgkJPFJlc3BvbnNlVHlwZT5hY2tub3dsZWRnZW1lbnQ8L1Jlc3BvbnNlVHlwZT4KCTwvSWRlbnRpZmljYXRpb24+CjwvUmVzcG9uc2VtZXNzYWdlPgo",
"description": "base64 encoded xml file of the response message",
"readOnly": false
}
}
}
}
}
},
"responses": {
"202": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrolltaxreturns/initiate": {
"post": {
"tags": [
"Initiate payroll tax return"
],
"description": "__Activity name :__ PostInitiatePayrollTaxReturnByPayrollAdministrationId\n\nThis is a controller endpoint to perform an action. \n\n\n __Metadata :__ \n There is a metadata endpoint that will return process information rather then true metadata. \n This endpoint is available by simply adding /metadata behind the URI.\n\n\n __Defaults :__ Default values for a new object can be acquired (GET) by adding `/defaults' to the POST URL. \n\n\n__Deprecated :__ This endpoint has a new version as of 2024-09-23. The current version will be obsolete from 2025-03-23. In the new version it is required to provide the payrollPeriod object in the request body.",
"summary": "Initiate payroll tax return (aanmaken loonaangifte)",
"operationId": "PostInitiatePayrollTaxReturnByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Initiate payroll tax return.",
"required": true,
"content": {
"application/json;version=2024-09-23": {
"schema": {
"$ref": "#/components/schemas/initiationParametersNew"
}
},
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/initiationParameters"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/initiatedPayrollTaxReturnRun"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrolltaxreturns/initiateForPreviousYear": {
"post": {
"tags": [
"Initiate payroll tax return"
],
"description": "__Activity name :__ PostInitiatePayrollTaxReturnPreviousYearsByPayrollAdministrationId
This is a controller endpoint to perform an action. Initiate payroll tax return for a closed year (aanmaken loonaangifte voorgaand jaar)
__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. \n",
"summary": "Initiate payroll tax return for a closed year (aanmaken loonaangifte voorgaand jaar)",
"operationId": "PostInitiatePayrollTaxReturnPreviousYearsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/X-ValidateOnly"
}
],
"requestBody": {
"description": "Initiate payroll tax return closed year.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/initiationParametersForPreviousPayrollYear"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/initiatedPayrollTaxReturnRun"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrolltaxreturns/initiateAnnual": {
"post": {
"tags": [
"Initiate payroll tax return"
],
"description": "__Activity name :__ PostInitiateAnnualPayrollTaxReturnByPayrollAdministrationId
This is a controller endpoint to perform an action. Initiate payroll tax return for a closed year (aanmaken loonaangifte voorgaand jaar)
__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. \n",
"summary": "Initiate an annual payroll tax return",
"operationId": "PostInitiateAnnualPayrollTaxReturnByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/X-ValidateOnly"
}
],
"requestBody": {
"description": "Initiate an annual payroll tax return year.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/initiationParameters"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/initiatedPayrollTaxReturnRun"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollperiods/{payrollPeriodId}/payrolltaxreturns": {
"post": {
"tags": [
"Initiate payroll tax return"
],
"description": "__Activity name :__ PostPayrollTaxReturnCollectiveByBearerToken This is a controller endpoint to perform an action.\n\n* The endpoint starts multiple payroll tax returns within one provider.\n* Only one payroll tax return per payrolladministration can be started.",
"summary": "Initiate payroll tax return Collective",
"operationId": "PostPayrollTaxReturnCollectiveByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollPeriodIdPath-2"
}
],
"requestBody": {
"description": "Initiate payroll tax return Payload.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollTaxReturnCollective"
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Payroll tax return"
],
"description": "__Activity name :__ PatchApprovePayrollTaxReturnCollectiveByBearerToken This is a controller endpoint to perform an action.\n\n* The endpoint patches multiple payroll tax returns within one provider.\n* Only one payroll tax return per payrolladministration can be patched.\n* This endpoint is similar to PatchPayrollTaxReturnsByPayrollTaxReturnIds except for the ids it works with and its progress which can be monitored.",
"summary": "Update payroll tax return status Collective",
"operationId": "PatchApprovePayrollTaxReturnCollectiveByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollPeriodIdPath-2"
}
],
"requestBody": {
"description": "Update Payroll Run Payload.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollTaxReturnCollective"
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrolltaxreturns/{payrolltaxreturnId}/undo": {
"post": {
"tags": [
"Undo payroll tax return"
],
"description": "__Activity name :__ PostUndoPayrollTaxReturnByPayrollTaxReturnId\n\nThis is a controller endpoint to perform an action. \nIn the older Loket GUI this specific action is referred to as 'Deactiveren loonaangifte' If this action is performed successfully then the payroll tax return will be marked 'deleted' in the sense that its results will be undone. Please note that situations where an approved payroll tax return would have to be 'undone' should be generally be avoided.\n\nBy undoing the payroll tax return for this period, it is not automatically removed from the tax authorities. After undoing the payroll tax return, you must recreate and confirm the payroll tax return for this period. Please pay attention to the deadline for confirmation. Subsequently, the payroll tax return received earlier by the tax authorities will be overwritten by this new one. \n\nThis action may only be performed successfully of the following requirements are met;\n\n* The payroll tax return is the very last payroll tax return that has been approved within this payroll administration\n* It is not possible to undo a payroll tax return if there is currently a payroll tax return with status 0 (to be processed) or 1 (awaiting approval) within the payroll administation. \n\n\n __Metadata :__ No metadata endpoint available for this controller endpoint.\n\n\n __Defaults :__ Defaults GET endpoint is available for this controller endpoint at the path `.../payrolladministrations/{payrollAdministrationId}/payrolltaxreturns/undo/defaults`.",
"summary": "Undo payroll tax return (verwijderen loonaangifte)",
"operationId": "PostUndoPayrollTaxReturnByPayrollTaxReturnId",
"parameters": [
{
"$ref": "#/components/parameters/payrolltaxreturnId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrolltaxreturns/withdrawIncomeRelationshipNumber": {
"post": {
"tags": [
"Payroll tax return"
],
"description": "__Activity name :__ PostWithdrawIncomeRelationshipNumberByPayrollAdministrationId\n\nThis is a controller endpoint to perform an action. \n\n\n __Metadata :__ This endpoint is available by simply adding /metadata behind the URI.\n\n\n __Defaults :__ No defaults endpoint available for this controller endpoint.",
"summary": "Add a withdraw an income relationship number to an open payroll tax return",
"operationId": "PostWithdrawIncomeRelationshipNumberByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Income relationship number to be withdrawn",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/withdrawParameters"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrolltaxreturns/{payrolltaxreturnId}/resend": {
"patch": {
"tags": [
"Payroll tax return"
],
"description": "__Activity name :__ PatchResendPayrollTaxReturnByPayrollTaxReturnId\n\nThis is a controller endpoint to perform an action. Only payroll tax returns that meet the following requirements can be resend * Must be send to the payroll tax authorities * Must not be 'deleted' * The payroll period must bij > 0 * Loket must be the application that send the payroll tax return to the payroll tax authorities\n\n __Metadata :__ No metadata endpoint available for this controller endpoint.\n\n\n __Defaults :__ No defaults endpoint available for this controller endpoint.",
"summary": "Resend payroll tax return (Herzenden loonaangifte)",
"operationId": "PatchResendPayrollTaxReturnByPayrollTaxReturnId",
"parameters": [
{
"$ref": "#/components/parameters/payrolltaxreturnId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/locationservices/address": {
"get": {
"tags": [
"Address"
],
"description": "__Activity name :__ GetAddressyByPostalCodeAndHouseNumber
Acquire the address for a combination of `postalCode` and `houseNumber`. Only Dutch addresses are supported. Both the postalCode and houseNumber have to be specified as query parameters to perform a successful call to this endpoint. The city and street name returned by this endpoint are according to the nen standard
\n",
"summary": "Acquire the address for a combination of `postalCode` and `houseNumber`",
"operationId": "GetAddressByPostalCodeAndHouseNumber",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/postalCode"
},
{
"$ref": "#/components/parameters/houseNumber"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/address-4"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/address/search": {
"get": {
"tags": [
"Location service"
],
"description": "__Activity name :__ GetSearchAddressByBearerToken\n\nUse fuzzy search to find an address. The response returns the GEO coördinates that can be used to calculate a route.\n",
"summary": "Search for an address",
"operationId": "GetSearchAddressByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/query"
},
{
"$ref": "#/components/parameters/lat"
},
{
"$ref": "#/components/parameters/lon"
},
{
"$ref": "#/components/parameters/top"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/addressObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/route/calculate": {
"get": {
"tags": [
"Location service"
],
"description": "__Activity name :__ GetCalculateRouteByBearerToken\n\nCalculates the dinstance (in KM) between the given GEO coördinates. Its possible to provide multiple stops for the calculation.\n",
"summary": "Calculates the distance for a given route",
"operationId": "GetCalculateRouteByBearerToken",
"servers": [
{
"url": "https://api.loket-acc.nl/geolocation"
}
],
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/query-2"
},
{
"$ref": "#/components/parameters/routeType"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/routeObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/aowDate": {
"get": {
"tags": [
"AOW date"
],
"description": "__Activity name:__ GetAowDateByDateOfBirth\n\nThis endpoint allows the user to acquire the AOW date of an employee.\n",
"summary": "Acquire the AOW date",
"operationId": "GetAowDateByDateOfBirth",
"parameters": [
{
"$ref": "#/components/parameters/dateOfBirth"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/aowDate"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/chamberofcommerce/{chamberOfCommerceNumber}/companyinformation": {
"get": {
"tags": [
"Chamber of commerce"
],
"description": "__Activity name:__ GetCompanyInformationByChamberOfCommerceNumber\n\nThis endpoint allows the user to acquire basic company information for a specific chamber of commerce number.\n",
"summary": "Acquire company information",
"operationId": "GetCompanyInformationByChamberOfCommerceNumber",
"parameters": [
{
"$ref": "#/components/parameters/chamberOfCommerceNumber"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/companyInformation"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/datanewbusinesstoken": {
"get": {
"tags": [
"Data New Business"
],
"description": "__Activity name :__ GetDataNewBusinessTokenByEmployerId\n\nGet a token for calling the Data New Business (DNB) API. DNB is a part of Van Spaendonck and with its API, DNB provides users data-based insights such as the salary checker. \n",
"summary": "Get Data New Business token for an employer",
"operationId": "GetDataNewBusinessTokenByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/dnbObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/datanewbusiness/token": {
"get": {
"tags": [
"Data New Business"
],
"description": "__Activity name :__ GetDataNewBusinessToken\n\nGet a token for calling the Data New Business (DNB) API. DNB is a part of Van Spaendonck and with its API, DNB provides users data-based insights such as the salary checker. \n",
"summary": "Get Data New Business token",
"operationId": "GetDataNewBusinessToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/dnbObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/datanewbusiness/functions": {
"get": {
"tags": [
"Data New Business"
],
"description": "__Activity name :__ GetDataNewBusinessFunctions
Get a list of functions known by Data New Business.
\n",
"summary": "Get a list of functions",
"operationId": "GetDataNewBusinessFunctions",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/functions"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/calendar/availablehours": {
"get": {
"tags": [
"Calendar"
],
"description": "__Activity name :__ GetCalendarAvailableHoursByEmployerId\n\nFor 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.\n\nThe 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).\n\nThis 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.\n",
"summary": "List available hours per employment (for calendar)",
"operationId": "GetCalendarAvailableHoursByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/startDate-2"
},
{
"$ref": "#/components/parameters/endDate-2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employerCalendarAvailability"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/calendar/leave": {
"get": {
"tags": [
"Calendar"
],
"description": "__Activity name :__ GetCalendarLeaveByEmployerId\n\nThis 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'.\n\nThis 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.\n",
"x-loket-implementation": "aanname 'alleen bij opname'",
"x-loket-implementation2": "Is het nodig om verschillende soorten weer te geven? Voor nu niet.",
"summary": "List leave per employment (for calendar)",
"operationId": "GetCalendarLeaveByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/startDate-2"
},
{
"$ref": "#/components/parameters/endDate-2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employerCalendarLeave"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/calendar/leaverequests": {
"get": {
"tags": [
"Calendar"
],
"description": "__Activity name :__ GetCalendarLeaveRequestsByEmployerId\n\nFor a calendar, this endpoint return the leave requests calendar items PER specific employment.\n\nPlease note: this endpoint only will return calendar items based on leave request with status 'ingediend'.\n\nThis 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.\n",
"x-loket-implementation": "aanname 'alleen bij opname' is dat terecht? Ja.",
"x-loket-implementation2": "Is het nodig om verschillende soorten weer te geven? Nee.",
"summary": "List leave requests per employment (for calendar)",
"operationId": "GetCalendarLeaveRequestsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/startDate-2"
},
{
"$ref": "#/components/parameters/endDate-2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employerCalendarLeaveRequest"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/calendar/revokeleaverequests": {
"get": {
"tags": [
"Calendar"
],
"description": "__Activity name :__ GetCalendarRevokeLeaveRequestsByEmployerId\n\nFor a calendar, this endpoint return the revoke leave requests calendar items PER specific employment.\n\nPlease note: this endpoint only will return calendar items based on leave request with status 'geaccepteerd met intrekkingsverzoek.'.\n\nThis 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.\n",
"summary": "List leave requests per employment (for calendar)",
"operationId": "GetCalendarRevokeLeaveRequestsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/startDate-2"
},
{
"$ref": "#/components/parameters/endDate-2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employerCalendarLeaveRequest"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/calendar/absences": {
"get": {
"tags": [
"Calendar"
],
"description": "__Activity name :__ GetCalendarAbsencesByEmployerId\n\nFor a calendar, this endpoint return the absence calendar items PER specific employment.\n\nThis 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.\n",
"x-loket-implementation": "let op uren gewerkt eerste dag. Arbeidsongeschikt precentage nvt voor nu",
"summary": "List absences per employment (for calendar)",
"operationId": "GetCalendarAbsencesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/startDate-2"
},
{
"$ref": "#/components/parameters/endDate-2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employerCalendarAbsence"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/teamCalendar": {
"get": {
"tags": [
"Calendar"
],
"description": "__Activity name :__ GetTeamCalendarByEmploymentId\n\nThis endpoint returns, for all the employments for the department of the employment of the {employmentId} in the PATH, per day the availability. \n\nNote that, if no `workPattern` is known for an employment saturday and sunday counted as non-workdays\n",
"summary": "Get the calendar data of the department of the employment",
"operationId": "GetTeamCalendarByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/startDate-2"
},
{
"$ref": "#/components/parameters/endDate-2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/leaveCalendar"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/personalCalendar": {
"get": {
"tags": [
"Calendar"
],
"description": "__Activity name :__ GetPersonalCalendarByEmploymentId\n\nGets the personal calendar\n\nNote that, if no `workPattern` is known for an employment saturday and sunday counted as non-workdays\n",
"summary": "Gets the personal calendar",
"operationId": "GetPersonalCalendarByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
},
{
"$ref": "#/components/parameters/startDate-2"
},
{
"$ref": "#/components/parameters/endDate-2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/leaveCalendar"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employmenttemplates": {
"get": {
"tags": [
"Employment template"
],
"description": "__Activity name :__ GetEmploymentTemplatesByEmployerId\nGet the employment templates that are available at this employer's level. \n\nAn 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.\n",
"summary": "Employment templates",
"operationId": "GetEmploymentTemplatesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"items": {
"$ref": "#/components/schemas/employmentTemplates"
}
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Employment template"
],
"description": "__Activity name :__ PostEmploymentTemplateByByEmployerId
Create a employment template 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 `../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}`.
* Possible options for payGrade can be acquired via `../v2/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 `../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}/paygrade/{payGradeKey}`. This endpoint has the optional parameter \\\"date\\\" that may be used to specifying a measure date.
__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 `/v2/providers/employers/employmenttemplates/defaults/payrolladministration/{payrollAdministrationId}` to the POST URL.
__NonPayrollAdministrations__ For nonPayrollAdministrations the equivalent MetaData-endpoints are also available as described above. Default values that are dependent on the selected non-payroll administration can be acquired via `/v2/providers/employers/employmenttemplates/defaults/nonpayrolladministration/{nonPayrollAdministrationId}`.
\"\n",
"summary": "Create an Employment template for an employer",
"operationId": "PostEmploymentTemplateByByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/X-ValidateOnly"
}
],
"requestBody": {
"description": "Employment template to create to the employer.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employmentTemplates"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employmentTemplates"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employmenttemplates/{employmenttemplateId}": {
"put": {
"tags": [
"Employment template"
],
"description": "__Activity name :__ PutEmploymentTemplateByEmploymentTemplateId\n\nEdit the details of an employment template\n\n* Possible options (metadata) for generic fields of the type \"metadata\" can be acquired (GET) by adding `/metadata` to the URL.\n* Possible options dependent on a specific payrollAdministration can be acquired via `../v2/providers/employers/conceptemployees/metadata/payrollAdministration/{payrollAdministrationId}`.\n* Possible options for payGrade can be acquired via `../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}`.\n\nA `payGrade` has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request `../v2/providers/employers/conceptemployees/metadata/payscale/{payScaleKey}/paygrade/{payGradeKey}`.\n\n\n__NonPayrollAdministrations__ For nonPayrollAdministrations the equivalent MetaData-endpoints are also available as described above. Default values that are dependent on the selected non-payroll administration can be acquired via `/v2/providers/employers/employmenttemplates/defaults/nonpayrolladministration/{nonPayrollAdministrationId}`.\n",
"summary": "Edit the details of an employment template",
"operationId": "PutEmploymentTemplateByEmploymentTemplateId",
"parameters": [
{
"$ref": "#/components/parameters/employmenttemplateId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/X-ValidateOnly"
}
],
"requestBody": {
"description": "Employment template to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/employmentTemplates"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/employmentTemplates"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Employment template"
],
"description": "__Activity name :__ DeleteEmploymentTemplateByEmploymentTemplateId\n\nDelete a employment template\n",
"summary": "Delete a employment template",
"operationId": "DeleteEmploymentTemplateByEmploymentTemplateId",
"parameters": [
{
"$ref": "#/components/parameters/employmenttemplateId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/declarations": {
"get": {
"tags": [
"Declarations"
],
"summary": "List of declarations for the employees of an employer",
"operationId": "GetDeclarationsByEmployerId",
"description": "__Activity name :__ GetDeclarationsByEmployerId\n\nReturns a list of declarations for the employments of the employer\n",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/declarationObject-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/declarations/review": {
"patch": {
"tags": [
"Declarations"
],
"summary": "Review (accept or reject) open declarations",
"description": "__Activity name :__ PatchReviewDeclarationsByDeclarationIds\n\nReview (accept or reject) open declarations\n\nPlease check the description of the status-field in this resource to read about the workflow of declarations.\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"operationId": "PatchReviewDeclarationsByDeclarationIds",
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/declarationsPatchObject"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/declarations/process": {
"patch": {
"tags": [
"Declarations"
],
"summary": "Process approved declarations",
"description": "__Activity name :__ PatchProcessDeclarationsByDeclarationId\n\nProcess approved declarations into the payrolling data.\n\nPlease check the description of the status-field in this resource to read about the workflow of declarations.\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
}
],
"operationId": "PatchProcessDeclarationsByDeclarationId",
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/declarationsProcessPatchObject"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/declarations/{declarationId}/attachment": {
"get": {
"tags": [
"Declarations attachments"
],
"description": "__Activity name :__ GetAttachmentByDeclarationId\n\nDownload the attachment (via Qwoater) for the given declarationId. In case no attachment is know the service will return a 404.\n",
"summary": "Download attachment",
"operationId": "GetAttachmentByDeclarationId",
"parameters": [
{
"$ref": "#/components/parameters/declarationId"
},
{
"$ref": "#/components/parameters/authorization"
}
],
"responses": {
"200": {
"description": "OK. Output type may be of any extension type that is supported by Qwoater."
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Declarations attachments"
],
"description": "__Activity name :__ PostAttachmentByDeclarationId\n\nUpload an attachment to a declaration. Via Qwoater.\n",
"summary": "Upload attachment",
"operationId": "PostAttachmentByDeclarationId",
"parameters": [
{
"$ref": "#/components/parameters/declarationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Document to be uploaded as attachment to the declaration.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/attachmentPostObject"
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/declarations/withattachment": {
"get": {
"tags": [
"Declarations attachments"
],
"description": "__Activity name :__ GetDeclarationsWithAttachmentByEmployerId\n\nGet a list of all declarationId's of declarations that have an attachment to it. \n\nThe 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.\n\nIf an attachment is available then a call may be performed to the attachment download endpoint to actually start downloading the attachment for this declaration.\n",
"summary": "Get a list of declarations with attachment",
"operationId": "GetDeclarationsWithAttachmentByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/declarationAttachmentObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/declarations/withattachment": {
"get": {
"tags": [
"Declarations attachments"
],
"description": "__Activity name :__ GetDeclarationsWithAttachmentByEmploymentId\n\nGet a list of all declarationId's of declarations that have an attachment to it. \n\nThe 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.\n\nIf an attachment is available then a call may be performed to the attachment download endpoint to actually start downloading the attachment for this declaration.\n",
"summary": "Get a list of declarations with attachment",
"operationId": "GetDeclarationsWithAttachmentByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/declarationAttachmentObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/qwoatermicroservice/providers/employers/employees/employments/declarations/withattachment": {
"get": {
"tags": [
"Declarations attachments"
],
"summary": "attachment indication for a set of declarationIds",
"description": "__Activity name :__ GetDeclarationsWithAttachmentByDeclarationIds\n\nThis endpoint returns from a set of declaration IDs, the declaration Ids for which an attachment is available\n\nAll declarationIds must belong to the same employerId.\n\nAttachments are 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.\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/declarationIds"
}
],
"operationId": "GetDeclarationsWithAttachmentByDeclarationIds",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/declarationIds"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/initialise": {
"post": {
"tags": [
"Initialise Payroll Period"
],
"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.\n",
"summary": "Initialise Payroll Period (automatische processen)",
"operationId": "PostInitialisePayrollPeriodByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Perform Calculation Payload.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/performCalculation"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollruns/initiate": {
"post": {
"tags": [
"Initiate payroll run"
],
"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 successfully 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 active 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 active 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
If typeOfInitiation = 'previousYear' (Verlonen voorgaande jaren);
* 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)
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.\n",
"summary": "Initiate payroll run (verlonen)",
"operationId": "PostInitiatePayrollRunByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Initiate Payroll Run Payload.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/postPayrollRun"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/initiatedPayrollRun"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollruns/{payrollPeriodId}/initiationvalues": {
"get": {
"tags": [
"Initiate payroll run"
],
"description": "__Activity name :__ GetPayrollrunInitiationvaluesByPayrollAdministrationIdAndPayrollPeriodId \n\nGet the initiation values for initiating a payrollrun for a specific period.\n",
"summary": "Initiationvalues of a payrollrun",
"operationId": "GetPayrollrunInitiationvaluesByPayrollAdministrationIdAndPayrollPeriodId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/payrollPeriodId-4"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payrollRunInitiationvalues"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollperiods/{payrollPeriodId}/payrollruns": {
"post": {
"tags": [
"Initiate payroll run"
],
"description": "__Activity name :__ PostPayrollRunCollectiveByBearerToken This is a controller endpoint to perform an action.\n\n* The endpoint starts multiple payrollruns within one provider.\n* Only one payrollrun per payrolladministration can be started.",
"summary": "Initiate payroll run Collective",
"operationId": "PostPayrollRunCollectiveByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollPeriodId-5"
}
],
"requestBody": {
"description": "Initiate Payroll Run Payload.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/postPayrollRunCollective"
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Review payroll run"
],
"description": "__Activity name :__ PatchApprovePayrollRunCollectiveByBearerToken This is a controller endpoint to perform an action.\n\n* The endpoint patches multiple payrollruns within one provider.\n* Only one payrollrun per payrolladministration can be patched.\n* Is endpoint is similar to PatchPayrollRunByPayrollRunIds except for the ids it works with and its progress which can be monitored.",
"summary": "Update payroll run status Collective",
"operationId": "PatchApprovePayrollRunCollectiveByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollPeriodId-5"
}
],
"requestBody": {
"description": "Update Payroll Run Payload.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/patchPayrollRunCollective"
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/undo": {
"post": {
"tags": [
"Undo payroll run"
],
"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 successfully 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 successfully 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 :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.
__Defaults :__ Defaults GET endpoint is available for this controller endpoint at the path `.../payrolladministrations/{payrollAdministrationId}/payrollruns/undo/defaults`.\n",
"summary": "Undo payroll run (verwijderen loonrun)",
"operationId": "UndoPayrollRunByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/payrollrunId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"201": {
"description": "Created"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/transitioncompensation/calculate/defaults": {
"get": {
"tags": [
"Transition compensation"
],
"description": "__Activity name :__ GetCalculateTransitionCompensationDefaultsByEmploymentId\n\n\n Get the default values of the input parameters for the POST action.\n",
"summary": "Get default input parameters transition compensation",
"operationId": "GetCalculateTransitionCompensationDefaultsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/inputParameters"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/transitioncompensation/calculate": {
"post": {
"tags": [
"Transition compensation"
],
"description": "This is a controller endpoint to perform a calculation. No actual data will be stored as a result of these actions.\n\n__Activity name :__ PostCalculateTransitionCompensationByEmploymentId\n\n__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)\n\nA calculation help for determining the transition compensation amount. (rekenhulp transitievergoeding)\n",
"summary": "Calculate transition compensation",
"operationId": "PostCalculateTransitionCompensationByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Transition compensation input parameters",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/inputParameters"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/outputParameters"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/documents": {
"get": {
"tags": [
"Employment dossier"
],
"description": "__Activity name :__ GetDocumentsByEmploymentId\n\nGet a list of documents within the employee's employment dossier (werknemerdossier). Via Qwoater.\n",
"summary": "Get a list of employment dossier documents",
"operationId": "GetDocumentsByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signDocumentObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Employment dossier"
],
"description": "__Activity name :__ PostDocumentByEmploymentId\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.\n\nUpload a document within the employee's employment dossier (werknemerdossier). Via Qwoater.\n",
"summary": "Upload a document to the employment dossier",
"operationId": "PostDocumentByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Document to be uploaded for the employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/documentPostObject"
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/documents/{documentId}": {
"get": {
"tags": [
"Employment dossier"
],
"description": "__Activity name :__ GetDocumentByEmploymentIdAndDocumentId\n\nDownload the file of a given employment dossier entry. Via Qwoater.\n",
"summary": "Download employment dossier document",
"operationId": "GetDocumentByEmploymentIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/documentId"
},
{
"$ref": "#/components/parameters/authorization"
}
],
"responses": {
"200": {
"description": "OK. Output type may be of any extension type that is supported by Qwoater."
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Employment dossier"
],
"description": "__Activity name:__ DeleteDocumentByEmploymentIdAndDocumentId\n\nDelete a document in the employment dossier\n",
"summary": "Delete a document in the employment dossier",
"operationId": "DeleteDocumentByEmploymentIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/documentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Employment dossier"
],
"description": "__Activity name:__ PutDocumentByEmploymentIdAndDocumentId\n\nEdit the details for a document in the employment dossier\n",
"summary": "Edit the details of an employment dossier document",
"operationId": "PutDocumentByEmploymentIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/documentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Document record to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/documentPutObject"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/documents/{documentId}/audittrail": {
"get": {
"tags": [
"Employment dossier"
],
"description": "__Activity name :__ GetAuditTrailByEmploymentIdAndDocumentId\n\nGet audittrail for the document in the employment dossier.\n",
"summary": "Get audittrail for the document in the employment dossier",
"operationId": "GetAuditTrailByEmploymentIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/documentId"
},
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/auditTrailObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/documents/{documentId}": {
"get": {
"tags": [
"Employer dossier"
],
"description": "__Activity name :__ GetDocumentByEmployerIdAndDocumentId\n\nDownload the file of a given employer dossier entry. Via Qwoater.\n",
"summary": "Download employer dossier document",
"operationId": "GetDocumentByEmployerIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/documentId-2"
},
{
"$ref": "#/components/parameters/authorization"
}
],
"responses": {
"200": {
"description": "OK. Output type may be of any extension type that is supported by Qwoater."
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Employer dossier"
],
"description": "__Activity name:__ DeleteDocumentByEmployerIdAndDocumentId\n\nDelete a document in the employer dossier\n",
"summary": "Delete a document in the employer dossier",
"operationId": "DeleteDocumentByEmployerIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/documentId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Employer dossier"
],
"description": "__Activity name:__ PutDocumentByEmployerIdAndDocumentId\n\nEdit the details for a document in the employer dossier\n",
"summary": "Edit the details of an employer dossier document",
"operationId": "PutDocumentByEmployerIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/documentId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Document record to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/documentPutObject-2"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/documents": {
"get": {
"tags": [
"Employer dossier"
],
"description": "__Activity name :__ GetDocumentsByEmployerId\n\nGet a list of documents within the employer dossier (werkgeverdossier). Via Qwoater.\n",
"summary": "Get a list of employer dossier documents",
"operationId": "GetDocumentsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/documentGetObject-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Employer dossier"
],
"description": "__Activity name :__ PostDocumentByEmployerId\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.\n\nUpload a document within the employer dossier (werkgeverdossier). Via Qwoater.\n",
"summary": "Upload a document to the employer dossier",
"operationId": "PostDocumentByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Document to be uploaded for the employer.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/documentPostObject-2"
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/documents/{documentId}/audittrail": {
"get": {
"tags": [
"Employer dossier"
],
"description": "__Activity name :__ GetAuditTrailByEmployerIdAndDocumentId\n\nGet audittrail for the document in the employer dossier.\n",
"summary": "Get audittrail for the document in the employer dossier",
"operationId": "GetAuditTrailByEmployerIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/documentId-2"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/auditTrailObject-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}": {
"get": {
"tags": [
"Concept employee dossier"
],
"description": "__Activity name :__ GetDocumentByConceptEmployeeIdAndDocumentId\n\nDownload the file of a given concept employee dossier entry. Via Qwoater.\n",
"summary": "Download concept employee dossier document",
"operationId": "GetDocumentByConceptEmployeeIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/documentId"
},
{
"$ref": "#/components/parameters/authorization"
}
],
"responses": {
"200": {
"description": "OK. Output type may be of any extension type that is supported by Qwoater."
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Concept employee dossier"
],
"description": "__Activity name:__ DeleteDocumentByConceptEmployeeIdAndDocumentId\n\nDelete a document in the concept employee dossier\n",
"summary": "Delete a document in the concept employee dossier",
"operationId": "DeleteDocumentByConceptEmployeeIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/documentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Concept employee dossier"
],
"description": "__Activity name:__ PutDocumentByConceptEmployeeIdAndDocumentId\n\nEdit the details for a document in the concept employee dossier\n",
"summary": "Edit the details of an concept employee dossier document",
"operationId": "PutDocumentByConceptEmployeeIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/documentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Document record to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/documentPutObject"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/documents": {
"get": {
"tags": [
"Concept employee dossier"
],
"description": "__Activity name :__ GetDocumentsByConceptEmployeeId\n\nGet a list of documents within the concept employee's dossier (werknemerdossier). Via Qwoater.\n",
"summary": "Get a list of concept employee dossier documents",
"operationId": "GetDocumentsByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signDocumentObject-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Concept employee dossier"
],
"description": "__Activity name :__ PostDocumentByConceptEmployeeId\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.\n\nUpload a document within the concept employee's dossier (werknemerdossier). Via Qwoater.\n",
"summary": "Upload a document to the concept employee dossier",
"operationId": "PostDocumentByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Document to be uploaded for the concept employee.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/documentPostObject-3"
}
}
}
},
"responses": {
"202": {
"description": "OK"
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}/audittrail": {
"get": {
"tags": [
"Concept employee dossier"
],
"description": "__Activity name :__ GetAuditTrailByConceptEmployeeIdAndDocumentId\n\nGet audittrail for the document in the concept employee dossier.\n",
"summary": "Get audittrail for the document in the concept employee dossier",
"operationId": "GetAuditTrailByConceptEmployeeIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/documentId"
},
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/auditTrailObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/dossier\"": {
"get": {
"tags": [
"Concept employee dossier"
],
"description": "__Activity name :__ GetDocumentCountByConceptEmployeeId\n\nGet a count of the number of documents in the dossier. Via Qwoater.\n",
"summary": "Document count",
"operationId": "GetDocumentCountByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/documentCountObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Concept employee dossier"
],
"description": "__Activity name:__ DeleteDossierByConceptEmployeeId\n\nDelete a complete dossier, with all documents in it, for the concept employee\n",
"summary": "Delete the complete concept employee dossier",
"operationId": "DeleteDossierByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/documenttemplates/{documentId}": {
"get": {
"tags": [
"Document template"
],
"description": "__Activity name :__ GetDocumentTemplateByEmployerIdAndDocumentId\n\nDownload the document template of a given template entry. Via Qwoater.\n",
"summary": "Download template document",
"operationId": "GetDocumentTemplateByEmployerIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/documentId-3"
},
{
"$ref": "#/components/parameters/authorization"
}
],
"responses": {
"200": {
"description": "OK.",
"content": {
"application/vnd.openxmlformats-officedocument.wordprocessingml.document": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Document template"
],
"description": "__Activity name:__ DeleteDocumentTemplateByEmployerIdAndDocumentId\n\nDelete a document template in the employer dossier\n",
"summary": "Delete a document template in the employer dossier",
"operationId": "DeleteDocumentTemplateByEmployerIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/documentId-3"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Document template"
],
"description": "__Activity name:__ PutDocumentTemplateByEmployerIdAndDocumentId\n\nEdit the details for a document template in the employer dossier\n",
"summary": "Edit the details of an document template",
"operationId": "PutDocumentTemplateByEmployerIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/documentId-3"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Document template record to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/documentPutObject-3"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/documenttemplates": {
"get": {
"tags": [
"Document template"
],
"description": "__Activity name :__ GetDocumentTemplatesByEmployerId\n\nGet a list of document templates within the employer dossier (werkgeverdossier). Via Qwoater. Note that the 'category' field contains the category of the template.\n",
"summary": "Get a list of document templates",
"operationId": "GetDocumentTemplatesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/documentGetObject-3"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Document template"
],
"description": "__Activity name :__ PostDocumentTemplateByEmployerId\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.\n\nUpload a document template within the employer dossier (werkgeverdossier). Via Qwoater.\n",
"summary": "Upload a document template to the employer dossier",
"operationId": "PostDocumentTemplateByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Document template to be uploaded for the employer.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/documentPostObject-4"
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/documenttemplates/{documentId}/generatedocument/preview": {
"post": {
"tags": [
"Generate document"
],
"description": "__Activity name :__ PostGenerateDocumentPreviewByEmploymentIdAndDocumentId\n\n__Metadata:__ Available templates can be acquired(GET) at Employer level(/v2/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).\n\nGenerate a document for an employment and receive a preview. Via Qwoater.\n",
"summary": "Generate a document for an employment - preview",
"operationId": "PostGenerateDocumentPreviewByEmploymentIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/documentId-4"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Metadata for the document to be generated.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/documentPostObject-5"
}
}
}
},
"responses": {
"200": {
"description": "OK.",
"content": {
"application/vnd.openxmlformats-officedocument.wordprocessingml.document": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/documenttemplates/{documentId}/generatedocument": {
"post": {
"tags": [
"Generate document"
],
"description": "__Activity name :__ PostGenerateDocumentByEmploymentIdAndDocumentId\n\n__Metadata:__ Available templates can be acquired(GET) at Employer level(/v2/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).\n\nGenerate a document for an employment and store it in the employment dossier. Via Qwoater.\n",
"summary": "Generate a document for an employment",
"operationId": "PostGenerateDocumentByEmploymentIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/documentId-4"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Metadata for the document to be generated.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/documentPostWithEmailObject"
}
}
}
},
"responses": {
"202": {
"description": "Accepted. Document is generated and stored."
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/documenttemplates/{documentId}/generatedocument/preview": {
"post": {
"tags": [
"Generate document"
],
"description": "__Activity name :__ PostGenerateDocumentPreviewByConceptEmployeeIdAndDocumentId\n\n__Metadata:__ Available templates can be acquired(GET) at Employer level(/v2/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).\n\nGenerate a document for an concept employee and receive a preview. Via Qwoater.\n",
"summary": "Generate a document for an concept employee - preview",
"operationId": "PostGenerateDocumentPreviewByConceptEmployeeIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/documentId-4"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Metadata for the document to be generated.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/documentPostObject-5"
}
}
}
},
"responses": {
"200": {
"description": "OK.",
"content": {
"application/vnd.openxmlformats-officedocument.wordprocessingml.document": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/documenttemplates/{documentId}/generatedocument": {
"post": {
"tags": [
"Generate document"
],
"description": "__Activity name :__ PostGenerateDocumentByConceptEmployeeIdAndDocumentId\n\n__Metadata:__ Available templates can be acquired(GET) at Employer level(/v2/v2/providers/employers/{conceptEmployeeId}/documenttemplates/generatedocument/metadata).\n\nGenerate a document for an concept employee and store it in the employment dossier. Via Qwoater.\n",
"summary": "Generate a document for an concept employee",
"operationId": "PostGenerateDocumentByConceptEmployeeIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/documentId-4"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Metadata for the document to be generated.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/documentPostObject-5"
}
}
}
},
"responses": {
"200": {
"description": "OK. Document is generated and stored."
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/documenttemplates/{documentId}/generatedocuments": {
"post": {
"tags": [
"Generate document"
],
"description": "__Activity name :__ PostGenerateDocumentsByEmployerIdAndDocumentId\n\n__Metadata:__ Available templates can be acquired(GET) at Employer level(/v2/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).\n\nGenerate 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)\n",
"summary": "Generate documents for selected employments",
"operationId": "PostGenerateDocumentsByEmployerIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/documentId-4"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Metadata for the document to be generated.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/documentPostWithEmployments"
}
}
}
},
"responses": {
"202": {
"description": "OK. The process of generating documents has started."
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/signature/report": {
"get": {
"tags": [
"Sign document"
],
"description": "__Activity name :__ GetSignatureReportByEmployerId\n\nRequire an excel file containing information on document signature requests.\n",
"summary": "Download signature report for an employer",
"operationId": "GetSignatureReportByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/startDate-3"
},
{
"$ref": "#/components/parameters/endDate-3"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/vnd.openxmlformats-officedocument.wordprocessingml.document": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/documents/{documentId}/signature/initiate": {
"post": {
"tags": [
"Sign document"
],
"description": "__Activity name :__ PostInitiateSignatureByEmploymentIdAndDocumentId\n\n__Metadata:__ No metadata available. Defaults are available by adding /defaults to the path.\n\nInitiate the proces to sign a document for an employment by one or more signers.\n",
"summary": "Initiate signature - Employment",
"operationId": "PostInitiateSignatureByEmploymentIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/documentId-4"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Contactinformation of the signers.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/documentSignObject"
}
}
}
}
},
"responses": {
"200": {
"description": "Initiated",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/signatureDocumentStatusObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/documents/{documentId}/signature": {
"get": {
"tags": [
"Sign document"
],
"description": "__Activity name :__ GetSignatureByEmploymentIdAndDocumentId\n\n__Metadata:__ No metadata available.\n\nRetrieve the status of the signing.\n",
"summary": "Signature details - Employment",
"operationId": "GetSignatureByEmploymentIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/documentId-4"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"$ref": "#/components/schemas/signatureStatusObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Sign document"
],
"description": "__Activity name :__ DeleteSignatureByEmploymentIdAndDocumentId\n\n__Metadata:__ No metadata available.\n\nDelete the proces to sign a document for an employment.\n",
"summary": "Delete signature - Employment",
"operationId": "DeleteSignatureByEmploymentIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/documentId-4"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK."
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/documents/{documentId}/signature/report": {
"get": {
"tags": [
"Sign document"
],
"description": "__Activity name :__ GetSignatureReportByEmploymentIdAndDocumentId\n\n__Metadata:__ No metadata available.\n\nReport of the signature.\n",
"summary": "Retrieve the report of the signing - Employment",
"operationId": "GetSignatureReportByEmploymentIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/documentId-4"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK.",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}/signature/initiate": {
"post": {
"tags": [
"Sign document"
],
"description": "__Activity name :__ PostInitiateSignatureByConceptEmployeeIdAndDocumentId\n\n__Metadata:__ No metadata available. Defaults are available by adding /defaults to the path.\n\nInitiate the proces to sign a document for an employment by one or more signers.\n",
"summary": "Initiate signature - Conceptemployee",
"operationId": "PostInitiateSignatureByConceptEmployeeIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/documentId-4"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Contactinformation of the signers.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/documentSignObject"
}
}
}
}
},
"responses": {
"200": {
"description": "Initiated",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/signatureDocumentStatusObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}/signature": {
"get": {
"tags": [
"Sign document"
],
"description": "__Activity name :__ GetSignatureByConceptEmployeeIdAndDocumentId\n\n__Metadata:__ No metadata available.\n\nRetrieve the status of the signing.\n",
"summary": "Signature details - Conceptemployee",
"operationId": "GetSignatureByConceptEmployeeIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/documentId-4"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"$ref": "#/components/schemas/signatureStatusObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Sign document"
],
"description": "__Activity name :__ DeleteSignatureByConceptEmployeeIdAndDocumentId\n\n__Metadata:__ No metadata available.\n\nDelete the proces to sign a document for an Conceptemployee.\n",
"summary": "Delete signature - Conceptemployee",
"operationId": "DeleteSignatureByConceptEmployeeIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/documentId-4"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK."
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}/signature/report": {
"get": {
"tags": [
"Sign document"
],
"description": "__Activity name :__ GetSignatureReportByConceptEmployeeIdAndDocumentId\n\n__Metadata:__ No metadata available.\n\nReport of the signature.\n",
"summary": "Retrieve the report of the signing - Conceptemployee",
"operationId": "GetSignatureReportByConceptEmployeeIdAndDocumentId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/documentId-4"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK.",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/documents/authorizations": {
"get": {
"tags": [
"Document Management"
],
"description": "__Activity name :__ GetDossierAuthorizationsByEmployerId\n\nGet the authorizations per role and per category. Via Qwoater.\n",
"summary": "List of authorizations",
"operationId": "GetDossierAuthorizationsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/authorizationsObject"
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Document Management"
],
"description": "__Activity name:__ PutDossierAuthorizationsByEmployerId\n\nEdit the authorizations. Categories not included in de request will be set to inaccessible for all roles.\n",
"summary": "Edit the authorization matrix",
"operationId": "PutDossierAuthorizationsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "The request body contains an array of objects containing a `employment` and an `action` field.",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/authorizationsObject"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/documents/completedossier/initiate": {
"post": {
"tags": [
"Document Management"
],
"description": "__Activity name:__ PostInitiateCompleteDossierByEmployerId\n\nInitiate the proces to generate a zip file containing the complete dossier. (via Qwoater)\n",
"summary": "Generate complete dossier",
"operationId": "PostInitiateCompleteDossierByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"202": {
"description": "Initiated",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/documents/completedossier": {
"delete": {
"tags": [
"Document Management"
],
"description": "__Activity name:__ DeleteCompleteDossierByEmployerId\n\nDelete all documents in the dossier of an employer and the underlying employments\n",
"summary": "Delete complete dossier",
"operationId": "DeleteCompleteDossierByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/dossier/report": {
"get": {
"tags": [
"Dossier report"
],
"description": "__Activity name :__ GetDossierReportByEmployerId\n\nGet an excel containing information about all documents for an employer and underlying employments.\n",
"summary": "Download dossier information for an employer",
"operationId": "GetDossierReportByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/employerId"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/apgpensiondeclarations": {
"get": {
"tags": [
"Apg pension declaration"
],
"description": "__Activity name :__ GetApgPensionDeclarationsByPayrollAdministrationId\n\n\nA list of APG pension declarations for an administration\n",
"summary": "List of APG pension declarations for an administration",
"operationId": "GetApgPensionDeclarationsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apgPensionDeclaration"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/apgpensiondeclarations/{apgPensionDeclarationId}": {
"get": {
"tags": [
"Apg pension declaration"
],
"description": "__Activity name :__ GetApgPensionDeclarationByApgPensionDeclarationId\n\n\nDetails of APG pension declaration\n",
"summary": "Detail APG pension declaration for an administration",
"operationId": "GetApgPensionDeclarationByApgPensionDeclarationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/apgPensionDeclarationId"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/apgPensionDeclaration"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Apg pension declaration"
],
"summary": "Change the status of a apg pension declaration",
"description": "__Activity name :__ PatchApgPensionDeclarationByApgPensionDeclarationId\n\n\nThis endpoints changes the status of the Apg pensiondeclaration based on the provided action.\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/apgPensionDeclarationId"
}
],
"operationId": "PatchApgPensionDeclarationByApgPensionDeclarationId",
"requestBody": {
"description": "The request body contains the action (cancel / confirm)\n",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apgPensionDeclarationPatch"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/apgpensiondeclarations/{apgPensionDeclarationId}/overview": {
"get": {
"tags": [
"Apg pension declaration"
],
"summary": "Download the overview report of an APG pension declaration",
"description": "__Activity name :__ GetOverviewByApgPensionDeclarationId\n\n\nDownload the APG pension declaration overiew\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/apgPensionDeclarationId"
}
],
"operationId": "GetOverviewByApgPensionDeclarationId",
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/apgpensiondeclarations/{apgPensionDeclarationId}/message": {
"get": {
"tags": [
"Apg pension declaration"
],
"summary": "Download the message of a of an APG pension declaration",
"description": "__Activity name :__ GetMessageByApgPensionDeclarationId \n\n\nDownload 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.\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/apgPensionDeclarationId"
}
],
"operationId": "GetMessageByApgPensionDeclarationId",
"responses": {
"200": {
"description": "OK",
"content": {
"application/xml": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/apgpensiondeclarations/initiate": {
"post": {
"tags": [
"Apg pension declaration"
],
"description": "__Activity name :__ PostInitiateApgPensionDeclarationByPayrollAdministrationId\n\n\nInitiate 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) \n",
"summary": "Initiate a APG pension declaration",
"operationId": "PostInitiateApgPensionDeclarationByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
}
],
"requestBody": {
"description": "Initiate declaration.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/initiationParametersPensionDeclaration"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/initiatedApgPensionDeclaration"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/apgpensiondeclarations/initiateForPreviousYear": {
"post": {
"tags": [
"Apg pension declaration"
],
"description": "__Activity name :__ PostInitiateApgPensionDeclarationPreviousYearsByPayrollAdministrationId
This is a controller endpoint to perform an action. Initiate pension declaration for a closed year (aanmaken pensioenaangifte voorgaand jaar)
__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. \n",
"summary": "Initiate APG pension declaration for a closed year (aanmaken pensioenaangifte voorgaand jaar)",
"operationId": "PostInitiateApgPensionDeclarationPreviousYearsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/X-ValidateOnly"
}
],
"requestBody": {
"description": "Initiate pension declaration previous year.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/initiationParametersForPreviousPayrollYear-2"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/initiatedApgPensionDeclaration"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/apgpensiondeclarations/{apgPensionDeclarationId}/undo": {
"post": {
"tags": [
"Apg pension declaration"
],
"description": "__Activity name :__ PostUndoApgPensionDeclarationByApgPensionDeclarationId\n\nThis is a controller endpoint to perform an action. \nPreviously this specific action was referred to as 'Deactiveren pensioenaangifte'. If this action is performed successfully then the APG pension declaration will be marked 'deleted' in the sense that its results will be undone. Please note that situations where an approved APG pension declaration would have to be 'undone' should generally be avoided.\n\nBy undoing the APG pension declaration for this period, it is not automatically removed from the APG pension provider. After undoing the APG pension declaration, you must recreate and confirm the APG pension declaration for this period. Please pay attention to the deadline for confirmation. Subsequently, the APG pension declaration received earlier by the APG pension provider will be overwritten by this new one. \n\nThis action may only be performed successfully if the following requirements are met;\n\n* The APG pension declaration is the very last APG pension declaration that has been approved and sent within this payroll administration\n* It is not possible to undo a APG pension declaration if there is currently a APG pension declaration with status 0 (to be processed) or 1 (awaiting approval) within the payroll administation. \n\n\n __Metadata :__ No metadata endpoint available for this controller endpoint.\n\n\n __Defaults :__ Defaults GET endpoint is available for this controller endpoint at the path `.../payrolladministrations/{payrollAdministrationId}/apgpensiondeclarations/undo/defaults`.",
"summary": "Undo APG pension declaration(verwijderen pensioenaangifte)",
"operationId": "PostUndoApgPensionDeclarationByApgPensionDeclarationId",
"parameters": [
{
"$ref": "#/components/parameters/apgPensionDeclarationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/upapensiondeclarations": {
"get": {
"tags": [
"Upa pension declaration"
],
"description": "__Activity name :__ GetUpaPensionDeclarationsByPayrollAdministrationId\n\nA list of UPA pension declarations for an administration\n",
"summary": "List of UPA pension declarations",
"operationId": "GetUpaPensionDeclarationsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/upaPensionDeclaration"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/externalparties/{externalPartyKey}/upapensiondeclarations/initiateforpreviousyear": {
"post": {
"tags": [
"Upa pension declaration"
],
"description": "__Activity name :__ PostInitiateUpaPensionDeclarationPreviousYearsByPayrollAdministrationId
This is a controller endpoint to perform an action. Initiate pension declaration for a closed year (aanmaken pensioenaangifte voorgaand jaar)
__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. \n\nThis endpoint has metadata and defaults endpoints. They can be accessed at:\n\n* Metadata endpoint: /v2/providers/employers/payrolladministrations/{payrollAdministrationId}/upapensiondeclarations/initiateforpreviousyear/metadata\n\n* Defaults endpoint: /v2/providers/employers/payrolladministrations/{payrollAdministrationId}/externalparties/{externalPartyKey}/upapensiondeclarations/initiateforpreviousyear/defaults\n",
"summary": "Initiate UPA pension declaration for a closed year (aanmaken pensioenaangifte voorgaand jaar)",
"operationId": "PostInitiateUpaPensionDeclarationPreviousYearsByPayrollAdministrationIdAndExternalPartyId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/externalPartyKey"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/X-ValidateOnly"
}
],
"requestBody": {
"description": "Initiate pension declaration closed year.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/initiationParametersForPreviousPayrollYear-2"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/initiatedUpaPensionDeclaration"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/upapensiondeclarations/{upaPensionDeclarationId}": {
"get": {
"tags": [
"Upa pension declaration"
],
"description": "__Activity name :__ GetUpaPensionDeclarationByUpaPensionDeclarationId\n\nDetails of UPA pension declaration\n",
"summary": "Detail UPA pension declaration",
"operationId": "GetUpaPensionDeclarationByUpaPensionDeclarationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/upaPensionDeclarationId"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/upaPensionDeclaration"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Upa pension declaration"
],
"summary": "Change the status of a upa pension declaration",
"description": "__Activity name :__ PatchUpaPensionDeclarationByUpaPensionDeclarationId\n\nThis endpoints changes the status of the Upa pensiondeclaration based on the provided action.\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/upaPensionDeclarationId"
}
],
"operationId": "PatchUpaPensionDeclarationByUpaPensionDeclarationId",
"requestBody": {
"description": "The request body contains the action (cancel / confirm)\n",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/upaPensionDeclarationPatch"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/upapensiondeclarations/{upaPensionDeclarationId}/undo": {
"post": {
"tags": [
"Upa pension declaration"
],
"description": "__Activity name :__ PostUndoUpaPensionDeclarationByUpaPensionDeclarationId\n\nThis is a controller endpoint to perform an action. \nPreviously this specific action was referred to as 'Deactiveren pensioenaangifte'. If this action is performed successfully then the UPA pension declaration will be marked 'deleted' in the sense that its results will be undone. Please note that situations where an approved UPA pension declaration would have to be 'undone' should generally be avoided.\n\nBy undoing the UPA pension declaration for this period, it is not automatically removed from the UPA pension provider. After undoing the UPA pension declaration, you must recreate and confirm the UPA pension declaration for this period. Please pay attention to the deadline for confirmation. Subsequently, the UPA pension declaration received earlier by the UPA pension provider will be overwritten by this new one. \n\nThis action may only be performed successfully if the following requirements are met;\n\n* The UPA pension declaration is the very last UPA pension declaration that has been approved and sent within this payroll administration\n* It is not possible to undo a UPA pension declaration if there is currently a UPA pension declaration with status 0 (to be processed) or 1 (awaiting approval) within the payroll administation. \n\n\n __Metadata :__ No metadata endpoint available for this controller endpoint.\n\n\n __Defaults :__ Defaults GET endpoint is available for this controller endpoint at the path `.../payrolladministrations/{payrollAdministrationId}/externalparties/{externalPartyKey}/upapensiondeclarations/undo/defaults`.",
"summary": "Undo upa pension declaration(verwijderen pensioenaangifte)",
"operationId": "PostUndoUpaPensionDeclarationByUpaPensionDeclarationId",
"parameters": [
{
"$ref": "#/components/parameters/upaPensionDeclarationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/upapensiondeclarations/{upaPensionDeclarationId}/message": {
"get": {
"tags": [
"Upa pension declaration"
],
"summary": "Download the message of a of an UPA pension declaration",
"description": "__Activity name :__ GetMessageByUpaPensionDeclarationId \n\nDownload 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.\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/upaPensionDeclarationId"
}
],
"operationId": "GetMessageByUpaPensionDeclarationId",
"responses": {
"200": {
"description": "OK",
"content": {
"application/xml": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/externalparties/{externalPartyKey}/upapensiondeclarations/initiate": {
"post": {
"tags": [
"Upa pension declaration"
],
"description": "__Activity name :__ PostInitiateUpaPensionDeclarationByPayrollAdministrationIdAndExternalPartyKey\n\nInitiate 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) \n\n* Defaults endpoint can be accessed at the path `.../payrolladministrations/{payrollAdministrationId}/externalparties/{externalPartyKey}/upapensiondeclarations/initiate/defaults`.\n",
"summary": "Initiate a UPA pension declaration",
"operationId": "PostInitiateUpaPensionDeclarationByPayrollAdministrationIdAndExternalPartyKey",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/externalPartyKey"
}
],
"requestBody": {
"description": "Initiate declaration.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/initiationParametersPensionDeclaration"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/initiatedUpaPensionDeclaration"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollperiods/{payrollPeriodId}/pensiondeclarations": {
"post": {
"tags": [
"Pension declaration"
],
"description": "__Activity name :__ PostPensionDeclarationCollectiveByBearerToken. This is a controller endpoint to perform an action.\n\n* The endpoint starts multiple pension declarations within one provider.\n* Only one pension declaration per payrolladministration / external party can be started.",
"summary": "Initiate pension declaration Collective",
"operationId": "PostPensionDeclarationCollectiveByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollPeriodIdPath-2"
}
],
"requestBody": {
"description": "Initiate pension declaration Payload.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/pensionDeclarationCollective"
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"patch": {
"tags": [
"Pension declaration"
],
"description": "__Activity name :__ PatchPensionDeclarationCollectiveByBearerToken This is a controller endpoint to perform an action.\n\n* The endpoint patches multiple pension declarations within one provider.\n* Only one pension declaration per payrolladministration / external party can be patched.",
"summary": "Update pension declaration status Collective",
"operationId": "PatchPensionDeclarationCollectiveByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollPeriodIdPath-2"
}
],
"requestBody": {
"description": "Update Pension Declaration Payload.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/pensionDeclarationCollective"
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/ExternalPartyIdentifications": {
"get": {
"tags": [
"Upa pension declaration"
],
"description": "__Activity name:__ GetExternalPartyIdentificationsByProviderId\n\nGet a list identification data for external parties at provider level\n",
"summary": "List of identification data for external parties",
"operationId": "GetExternalPartyIdentificationsByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/externalPartyIdentificationPut"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Upa pension declaration"
],
"description": "__Activity name :__ PostExternalPartyIdentificationByProviderId\n\nAdd the identification data for an external party for a provider\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.\n\n__Defaults:__ Geen\n",
"summary": "Add the identification data for an external party for a provider",
"operationId": "PostExternalPartyIdentificationByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/externalPartyIdentificationPost"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/externalPartyIdentificationPut"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/ExternalPartyIdentifications/{externalPartyIdentificationId}": {
"get": {
"tags": [
"Upa pension declaration"
],
"description": "__Activity name :__ GetExternalPartyIdentificationAtProviderLevelByExternalPartyIdentificationId\n\nGet the details external party identification for a provider\n",
"summary": "Details of an external party identification for a provider",
"operationId": "GetExternalPartyIdentificationAtProviderLevelByExternalPartyIdentificationId",
"parameters": [
{
"$ref": "#/components/parameters/externalPartyIdentificationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/externalPartyIdentificationPut"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Upa pension declaration"
],
"description": "__Activity name :__ PutExternalPartyIdentificationAtProviderLevelByExternalPartyIdentificationId\n\n__Metadata :__ Geen\n",
"summary": "Edit an external party identification record",
"operationId": "PutExternalPartyIdentificationAtProviderLevelByExternalPartyIdentificationId",
"parameters": [
{
"$ref": "#/components/parameters/externalPartyIdentificationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/externalPartyIdentificationPut"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/externalPartyIdentificationPut"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Upa pension declaration"
],
"description": "__Activity name :__ DeleteExternalPartyIdentificationAtProviderLevelByExternalPartyIdentificationId\n\nDelete an external party identification record\n",
"summary": "Delete an external party identification record",
"operationId": "DeleteExternalPartyIdentificationAtProviderLevelByExternalPartyIdentificationId",
"parameters": [
{
"$ref": "#/components/parameters/externalPartyIdentificationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrollAdministrations/{payrollAdministrationId}/ExternalPartyIdentifications\"": {
"get": {
"tags": [
"Upa pension declaration"
],
"description": "__Activity name:__ GetExternalPartyIdentificationsByPayrollAdministrationId\n\nGet a list identification data for external parties at payroll administration level\n",
"summary": "List of identification data for external parties on payroll administration level",
"operationId": "GetExternalPartyIdentificationsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/externalPartyIdentificationPut"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Upa pension declaration"
],
"description": "__Activity name :__ PostExternalPartyIdentificationByPayrollAdministrationId\n\nAdd the identification data for an external party for a payroll administration\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.\n\n__Defaults:__ Geen\n",
"summary": "Add the identification data for an external party for a payroll administration",
"operationId": "PostExternalPartyIdentificationByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/externalPartyIdentificationPost"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/externalPartyIdentificationPut"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrollAdministrations/ExternalPartyIdentifications/{externalPartyIdentificationId}": {
"get": {
"tags": [
"Upa pension declaration"
],
"description": "__Activity name :__ GetExternalPartyIdentificationAtPayrollAdministrationLevelByExternalPartyIdentificationId\n\nGet the details external party identification for a payroll administration\n",
"summary": "Details of an external party identification for a payroll administration",
"operationId": "GetExternalPartyIdentificationAtPayrollAdministrationLevelByExternalPartyIdentificationId",
"parameters": [
{
"$ref": "#/components/parameters/externalPartyIdentificationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/externalPartyIdentificationPut"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Upa pension declaration"
],
"description": "__Activity name :__ PutExternalPartyIdentificationAtPayrollAdministrationLevelByExternalPartyIdentificationId\n\n__Metadata :__ Geen\n",
"summary": "Edit an external party identification record",
"operationId": "PutExternalPartyIdentificationAtPayrollAdministrationLevelByExternalPartyIdentificationId",
"parameters": [
{
"$ref": "#/components/parameters/externalPartyIdentificationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/externalPartyIdentificationPut"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/externalPartyIdentificationPut"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Upa pension declaration"
],
"description": "__Activity name :__ DeleteExternalPartyIdentificationAtPayrollAdministrationLevelByExternalPartyIdentificationId\n\nDelete an external party identification record\n",
"summary": "Delete an external party identification record",
"operationId": "DeleteExternalPartyIdentificationAtPayrollAdministrationLevelByExternalPartyIdentificationId",
"parameters": [
{
"$ref": "#/components/parameters/externalPartyIdentificationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/pensionWageStatement/Stipp/initiationvalues": {
"get": {
"tags": [
"Pension wage statement"
],
"description": "__Activity name :__ GetStippPensionWageStatementInitiationValuesByPayrollAdministrationId\n\nThe details required to start the process of a pension wage statement (PLO) for STIPP\n",
"summary": "Pension wage statement process initiation values for STIPP",
"operationId": "GetStippPensionWageStatementInitiationValuesByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/stippInitiationInformation"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/pensionWageStatement/Stipp/payrollRuns": {
"get": {
"tags": [
"Pension wage statement"
],
"description": "__Activity name :__ GetStippPensionWageStatementPayrollRunsByPayrollAdministrationId\n\nThe list of all the payroll runs that will be included in the next pension wage statement (PLO) for STIPP.\nOr a list of all the payroll runs that where in cluded in the last PLO \n",
"summary": "List of all the payroll runs for the pension wage statement STIPP",
"operationId": "GetStippPensionWageStatementPayrollRunsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/referenceDate-3"
},
{
"$ref": "#/components/parameters/process"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/stippDownloadInformation"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/pensionWageStatement/Stipp": {
"post": {
"tags": [
"Pension wage statement"
],
"description": "__Activity name :__ PostStippDownloadPensionWageStatementByPayrollAdministrationId\n\nMarks the payroll runs as processed and returns the pension wage statement for STIPP as a txt file.\n\n__Note:__ This endpoint can only be used to start a PLO for the active payroll year (actief verloningsjaar)\n",
"summary": "Download a pension wage statement for STIPP",
"operationId": "PostStippDownloadPensionWageStatementByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/referenceDateRequired-2"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/stippDownloadInput"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Pension wage statement"
],
"description": "__Activity name:__ DeleteStippPensionWageStatementByPayrollAdministrationId\n\nDelete the last created pension wage statement for STIPP. \nDeleting is done in order of creation \n",
"summary": "Delete the last created pension wage statement for STIPP",
"operationId": "DeleteStippPensionWageStatementByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"get": {
"tags": [
"Pension wage statement"
],
"description": "__Activity name :__ GetStippPensionWageStatementReportByPayrollAdministrationId\n\nAcquire the pension wage statement report for STIPP for the given (payroll)year.\n",
"summary": "Download the pension wage statement report for STIPP",
"operationId": "GetStippPensionWageStatementReportByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/reportYear"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/pensionWageStatement/Pggm/initiationvalues": {
"get": {
"tags": [
"Pension wage statement"
],
"description": "__Activity name :__ GetPggmPensionWageStatementInitiationValuesByPayrollAdministrationId\n\nThe details required to start the process of a pension wage statement (PLO) for PGGM\n",
"summary": "Pension wage statement process initiation values for PGGM",
"operationId": "GetPggmPensionWageStatementInitiationValuesByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/pggmInitiationInformation"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/pensionWageStatement/Pggm/payrollRuns": {
"get": {
"tags": [
"Pension wage statement"
],
"description": "__Activity name :__ GetPggmPensionWageStatementPayrollRunsByPayrollAdministrationId\n\nThe list of all the payroll runs that will be included in the next pension wage statement (PLO) for PGGM.\n",
"summary": "List of all the payroll runs for the pension wage statement PGGM",
"operationId": "GetPggmPensionWageStatementPayrollRunsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/referenceDate-3"
},
{
"$ref": "#/components/parameters/process"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/pggmDownloadInformation"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/pensionWageStatement/Pggm": {
"post": {
"tags": [
"Pension wage statement"
],
"description": "__Activity name :__ PostPggmDownloadPensionWageStatementByPayrollAdministrationId\n\nMarks the payroll runs as processed and returns the pension wage statement for PGGM as a txt file.\n\n__Note:__ This endpoint can only be used to start a PLO for the active payroll year (actief verloningsjaar)\n",
"summary": "Download a pension wage statement for PGGM",
"operationId": "PostPggmDownloadPensionWageStatementByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/referenceDateRequired-2"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/pggmDownloadInput"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Pension wage statement"
],
"description": "__Activity name:__ DeletePggmPensionWageStatementByPayrollAdministrationId\n\nDelete the last created pension wage statement for PGGM. \nDeleting is done in order of creation \n",
"summary": "Delete the last created pension wage statement for PGGM",
"operationId": "DeletePggmPensionWageStatementByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"get": {
"tags": [
"Pension wage statement"
],
"description": "__Activity name :__ GetPggmPensionWageStatementReportByPayrollAdministrationId\n\nAcquire the pension wage statement report for PGGM for the given (payroll)year.\n",
"summary": "Download the pension wage statement report for PGGM",
"operationId": "GetPggmPensionWageStatementReportByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/reportYear"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/users/downloadrequests": {
"get": {
"tags": [
"Download request"
],
"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.
",
"summary": "List of download requests for an employment",
"operationId": "GetDownloadRequestsByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/downloadRequest"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Download request"
],
"description": "__Activity name:__ PostDownloadRequestByBearerToken
Create a download request for an employment
",
"summary": "Create a download request",
"operationId": "PostDownloadRequestByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Download request to add to the employment.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/downloadRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/downloadRequest"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/users/downloadrequests/{downloadRequestId}": {
"get": {
"tags": [
"Download request"
],
"description": "__Activity name:__ GetDownloadRequestByDownloadRequestId\n\nGet the details of a download request record\n",
"summary": "Details of a download request record",
"operationId": "GetDownloadRequestByDownloadRequestId",
"parameters": [
{
"$ref": "#/components/parameters/downloadRequestId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/downloadRequest"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Download request"
],
"description": "__Activity name:__ DeleteDownloadRequestByDownloadRequestId\n\nDelete a download request for the employment\n",
"summary": "Delete a specific download request record",
"operationId": "DeleteDownloadRequestByDownloadRequestId",
"parameters": [
{
"$ref": "#/components/parameters/downloadRequestId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/users/downloadrequests/{downloadRequestId}/file": {
"get": {
"tags": [
"Download request"
],
"description": "__Activity name:__ GetFileByDownloadRequestId\n\nDownload the file of a download request record\n",
"summary": "Download file of download request",
"operationId": "GetFileByDownloadRequestId",
"parameters": [
{
"$ref": "#/components/parameters/downloadRequestId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/vnd.rar": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/notes": {
"get": {
"tags": [
"Employer notes"
],
"description": "__Activity name :__ GetEmployerNotesByEmployerId\n\nGet a list of notes, available for the user, for the employer. \n",
"summary": "Get a list of notes for an employer.",
"operationId": "GetEmployerNotesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/note"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Employer notes"
],
"description": "__Activity name :__ PostEmployerNoteByEmployerId\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.\n\n__Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.\n",
"summary": "Add a note for an employer",
"operationId": "PostEmployerNoteByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a note",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/note"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/note"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/notes/{noteId}": {
"get": {
"tags": [
"Employer notes"
],
"description": "__Activity name :__ GetEmployerNoteByNoteId\n\nGet the details of a note\n",
"summary": "Details of an employer note",
"operationId": "GetEmployerNoteByNoteId",
"parameters": [
{
"$ref": "#/components/parameters/noteId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/note"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Employer notes"
],
"description": "__Activity name :__ PutEmployerNoteByNoteId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.\n",
"summary": "Edit an employer note record",
"operationId": "PutEmployerNoteByNoteId",
"parameters": [
{
"$ref": "#/components/parameters/noteId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/note"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/note"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Employer notes"
],
"description": "__Activity name :__ DeleteEmployerNoteByNoteId\n\nDelete an existing note record\n",
"summary": "Delete an employer note record",
"operationId": "DeleteEmployerNoteByNoteId",
"parameters": [
{
"$ref": "#/components/parameters/noteId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/{employeeId}/notes": {
"get": {
"tags": [
"Employee notes"
],
"description": "__Activity name :__ GetEmployeeNotesByEmployeeId\n\nGet a list of notes, available for the user, for the employee. \n",
"summary": "Get a list of notes for an employee.",
"operationId": "GetEmployeeNotesByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/note"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Employee notes"
],
"description": "__Activity name :__ PostEmployeeNoteByEmployeeId\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.\n\n__Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.\n",
"summary": "Add a note for an employee",
"operationId": "PostEmployeeNoteByEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/employeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a note",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/note"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/note"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/notes/{noteId}": {
"get": {
"tags": [
"Employee notes"
],
"description": "__Activity name :__ GetEmployeeNoteByNoteId\n\nGet the details of a note\n",
"summary": "Details of an employee note",
"operationId": "GetEmployeeNoteByNoteId",
"parameters": [
{
"$ref": "#/components/parameters/noteId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/note"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Employee notes"
],
"description": "__Activity name :__ PutEmployeeNoteByNoteId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.\n",
"summary": "Edit an employee note record",
"operationId": "PutEmployeeNoteByNoteId",
"parameters": [
{
"$ref": "#/components/parameters/noteId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/note"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/note"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Employee notes"
],
"description": "__Activity name :__ DeleteEmployeeNoteByNoteId\n\nDelete an existing note record\n",
"summary": "Delete an employee note record",
"operationId": "DeleteEmployeeNoteByNoteId",
"parameters": [
{
"$ref": "#/components/parameters/noteId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/notes": {
"get": {
"tags": [
"Employee notes"
],
"description": "__Activity name :__ GetEmployeeNotesByEmployerId\n\nGet a list of employee notes, available for the user, for all employees of the employer. \n",
"summary": "Get a list of employee notes for an employer.",
"operationId": "GetEmployeeNotesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notesByEmployer"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/{conceptEmployeeId}/notes": {
"get": {
"tags": [
"Concept employee notes"
],
"description": "__Activity name :__ GetConceptEmployeeNotesByConceptEmployeeId\n\nGet a list of notes, available for the user, for the conceptemployee. \n",
"summary": "Get a list of notes for an conceptemployee.",
"operationId": "GetConceptEmployeeNotesByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/note"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Concept employee notes"
],
"description": "__Activity name :__ PostConceptEmployeeNoteByConceptEmployeeId\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.\n\n__Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.\n",
"summary": "Add a note for an conceptemployee",
"operationId": "PostConceptEmployeeNoteByConceptEmployeeId",
"parameters": [
{
"$ref": "#/components/parameters/conceptEmployeeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a note",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/note"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/note"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/notes/{noteId}": {
"get": {
"tags": [
"Concept employee notes"
],
"description": "__Activity name :__ GetConceptEmployeeNoteByNoteId\n\nGet the details of a note\n",
"summary": "Details of an conceptemployee note",
"operationId": "GetConceptEmployeeNoteByNoteId",
"parameters": [
{
"$ref": "#/components/parameters/noteId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/note"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Concept employee notes"
],
"description": "__Activity name :__ PutConceptEmployeeNoteByNoteId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.\n",
"summary": "Edit an conceptemployee note record",
"operationId": "PutConceptEmployeeNoteByNoteId",
"parameters": [
{
"$ref": "#/components/parameters/noteId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/note"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/note"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Concept employee notes"
],
"description": "__Activity name :__ DeleteConceptEmployeeNoteByNoteId\n\nDelete an existing note record\n",
"summary": "Delete an conceptemployee note record",
"operationId": "DeleteConceptEmployeeNoteByNoteId",
"parameters": [
{
"$ref": "#/components/parameters/noteId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/notes": {
"get": {
"tags": [
"Employment notes"
],
"description": "__Activity name :__ GetEmploymentNotesByEmploymentId\n\nGet a list of notes, available for the user, for the employment. \n",
"summary": "Get a list of notes for an employment.",
"operationId": "GetEmploymentNotesByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/note"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Employment notes"
],
"description": "__Activity name :__ PostEmploymentNoteByEmploymentId\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.\n\n__Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.\n",
"summary": "Add a note for an employment",
"operationId": "PostEmploymentNoteByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a note",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/note"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/note"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/notes/{noteId}": {
"get": {
"tags": [
"Employment notes"
],
"description": "__Activity name :__ GetEmploymentNoteByNoteId\n\nGet the details of an employment note\n",
"summary": "Details of an employment note",
"operationId": "GetEmploymentNoteByNoteId",
"parameters": [
{
"$ref": "#/components/parameters/noteId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/note"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Employment notes"
],
"description": "__Activity name :__ PutEmploymentNoteByNoteId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.\n",
"summary": "Edit an employment note record",
"operationId": "PutEmploymentNoteByNoteId",
"parameters": [
{
"$ref": "#/components/parameters/noteId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/note"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/note"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Employment notes"
],
"description": "__Activity name :__ DeleteEmploymentNoteByNoteId\n\nDelete an existing note record\n",
"summary": "Delete an employment note record",
"operationId": "DeleteEmploymentNoteByNoteId",
"parameters": [
{
"$ref": "#/components/parameters/noteId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/notes": {
"get": {
"tags": [
"Employment notes"
],
"description": "__Activity name :__ GetEmploymentNotesByEmployerId\n\nGet a list of employment notes, available for the user, for all employments of the employer. \n",
"summary": "Get a list of employment notes for an employer.",
"operationId": "GetEmploymentNotesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notesByEmployer-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/notes": {
"get": {
"tags": [
"Payroll run notes"
],
"description": "__Activity name :__ GetPayrollRunNotesByPayrollRunId\n\nGet a list of notes, available for the user, for the payroll run. \n",
"summary": "Get a list of notes for a payroll run.",
"operationId": "GetPayrollRunNotesByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/payrollrunId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/note"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Payroll run notes"
],
"description": "__Activity name :__ PostPayrollRunNoteByPayrollRunId\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.\n\n__Defaults:__ Default values for a new object can be acquired by adding `/defaults' to the POST URL.\n",
"summary": "Add a note for a payroll run",
"operationId": "PostPayrollRunNoteByPayrollRunId",
"parameters": [
{
"$ref": "#/components/parameters/payrollrunId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Add a note",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/note"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/note"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/payrollruns/notes/{noteId}": {
"get": {
"tags": [
"Payroll run notes"
],
"description": "__Activity name :__ GetPayrollRunNoteByNoteId\n\nGet the details of a note\n",
"summary": "Details of a payroll run note",
"operationId": "GetPayrollRunNoteByNoteId",
"parameters": [
{
"$ref": "#/components/parameters/noteId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/note"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Payroll run notes"
],
"description": "__Activity name :__ PutPayrollRunNoteByNoteId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding ` / metadata ` to the PUT URL.\n",
"summary": "Edit a payroll run note record",
"operationId": "PutPayrollRunNoteByNoteId",
"parameters": [
{
"$ref": "#/components/parameters/noteId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/note"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/note"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Payroll run notes"
],
"description": "__Activity name :__ DeletePayrollRunNoteByNoteId\n\nDelete an existing note record\n",
"summary": "Delete a payroll run note record",
"operationId": "DeletePayrollRunNoteByNoteId",
"parameters": [
{
"$ref": "#/components/parameters/noteId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollruns/notes": {
"get": {
"tags": [
"Payroll run notes"
],
"description": "__Activity name :__ GetPayrollRunNotesByPayrollAdministrationId\n\nGet a list of payrollrun notes, available for the user, for all payrollruns of the payrolladministration. \n",
"summary": "Get a list of payrollrun notes for an payrolladministration.",
"operationId": "GetPayrollRunNotesByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notesByPayrollAdministration"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/lastmodifiedversionnumbers": {
"get": {
"tags": [
"Last modified version numbers"
],
"description": "__Activity name :__ GetEmployerLastModifiedVersionNumbersByUser\n\n**What does the 'last modified' version number reflect**\n\nThe sequence number of an employer is a sequential number that reflects whether any changes have occurred in any of its UNDERLYING employments.\n\nMore 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)\n\nThe scope of this predefined set is to represent 'static' employment data (vaste gegevens), and thus excludes payroll period data (variabele gegevens).\n\n**When to use**\n\nThis 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.\n\n**How to use**\n\nWith 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).\nConsequently, 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`.\n\n*Recommended usage*\n\n* Perform your regular synchronization of static employment data\n* Store the highest version number, for which you have now processed all changes. (You may use the following parameter to do this `?orderBy=-lastModifiedVersionNumber` )\n* Next time you want to perform synchronization. Call this endpoint with parameter `?filter=lastModifiedVersionNumber gt {{YourVersionNumber}}`\n* 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)\n",
"summary": "List of employer last modified version numbers",
"operationId": "GetEmployerLastModifiedVersionNumbersByUser",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/versionObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/lastmodifiedversionnumbers": {
"get": {
"tags": [
"Last modified version numbers"
],
"description": "__Activity name :__ GetEmploymentLastModifiedVersionNumbersByEmployerId\n\nThis endpoint is similar to the GetEmployerLastModifiedVersionNumbersByUser endpoint described above. Please check out that description for required context.\n\nIn 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.\n\nAs can be seen in the set of 'underlying' tables, also changes in Employee information corresponding to the Employment is reflected in the version number.\n\n**How to use**\n\n*Recommended usage*\n* Perform all recommended steps in the description of the employer version number endpoint\n* 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.\n",
"summary": "List of employment version numbers",
"operationId": "GetEmploymentLastModifiedVersionNumbersByUser",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/versionObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/emailtemplates": {
"get": {
"tags": [
"Emailtemplates"
],
"description": "__Activity name :__ GetEmailTemplatesByProviderId\n\nGet a list of the email templates for an provider.\n\n__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.\n",
"summary": "List email templates for an provider",
"operationId": "GetEmailTemplatesByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/emailTemplate"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/emailtemplates/{emailTemplateId}": {
"get": {
"tags": [
"Emailtemplates"
],
"description": "__Activity name :__ GetEmailTemplateByProviderIdAndEmailTemplateId\n\nGet the details of an email template. The available email template placeholders can be aquired by adding /metadata to the url.\n",
"summary": "Details of an provider email template",
"operationId": "GetEmailTemplateByProviderIdAndEmailTemplateId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/emailTemplateId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/emailTemplate"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Emailtemplates"
],
"description": "__Activity name :__ PutEmailTemplateByProviderIdAndEmailTemplateId\n\nEdit the email template. The subject, body and senderEmail can be editted. \n",
"summary": "Edit an email template record at provider level",
"operationId": "PutEmailTemplateByProviderIdAndEmailTemplateId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/emailTemplateId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/emailTemplateRequestBody"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/emailTemplate"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Emailtemplates"
],
"description": "__Activity name :__ DeleteEmailTemplateByProviderIdAndEmailTemplateId\n\nDelete an existing provider email template record\n",
"summary": "Delete an email template record",
"operationId": "DeleteEmailTemplateByProviderIdAndEmailTemplateId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/emailTemplateId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/emailtemplates/{emailTemplateId}/sendtestemail": {
"post": {
"tags": [
"Emailtemplates"
],
"description": "__Activity name :__ PostSendTestEmailByProviderIdAndEmailTemplateId\n\nSend an example of a provider email template.\n",
"summary": "Send an example of a provider email template",
"operationId": "PostSendTestEmailByProviderIdAndEmailTemplateId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/emailTemplateId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Send test email request body",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/sendTestEmailRequestBody"
}
}
}
}
}
},
"/v2/providers/employers/{employerId}/emailtemplates": {
"get": {
"tags": [
"Emailtemplates"
],
"description": "__Activity name :__ GetEmailTemplatesByEmployerId\n\nGet a list of the email templates for an employer.\n\n__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.\n",
"summary": "List email templates for an employer",
"operationId": "GetEmailTemplatesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/emailTemplate-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/emailtemplates/{emailTemplateId}": {
"get": {
"tags": [
"Emailtemplates"
],
"description": "__Activity name :__ GetEmailTemplateByEmployerIdAndEmailTemplateId\n\nGet the details of an email template. The available email template placeholders can be aquired by adding /metadata to the url.\n",
"summary": "Details of an email template",
"operationId": "GetEmailTemplateByEmployerIdAndEmailTemplateId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/emailTemplateId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/emailTemplate-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Emailtemplates"
],
"description": "__Activity name :__ PutEmailTemplateByEmployerIdAndEmailTemplateId\n\nEdit the email template. The subject, body and senderEmail can be editted. \n",
"summary": "Edit an employer email template record",
"operationId": "PutEmailTemplateByEmployerIdAndEmailTemplateId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/emailTemplateId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/emailTemplateRequestBody"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/emailTemplate-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Emailtemplates"
],
"description": "__Activity name :__ DeleteEmailTemplateByEmployerIdAndEmailTemplateId\n\nDelete an existing employer email template record\n",
"summary": "Delete an email template record",
"operationId": "DeleteEmailTemplateByEmployerIdAndEmailTemplateId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/emailTemplateId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/emailtemplates/{emailTemplateId}/sendtestemail": {
"post": {
"tags": [
"Emailtemplates"
],
"description": "__Activity name :__ PostSendTestEmailByEmployerIdAndEmailTemplateId\n\nSend an example of an employer email template.\n",
"summary": "Send an example of an employer email template",
"operationId": "PostSendTestEmailByEmployerIdAndEmailTemplateId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/emailTemplateId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Send test email request body",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/sendTestEmailRequestBody"
}
}
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/eventnotificationconfigurations": {
"get": {
"tags": [
"Event notification configuration"
],
"description": "__Activity name :__ GetEventNotificationConfigurationsByPayrollAdministrationId\n\nGet a list of the notification configurations for certain events for an employer. Currently its only possible to configure email recipients for an event notification.\n\n__Note:__ Event notifications can be configured on payroll administration and provider level. This endpoint returns the provider level value if no value exists on the payroll administration level and if neither level has a value an empty event is returned.\n",
"summary": "The event notification configuration for a payroll administration",
"operationId": "GetEventNotificationConfigurationsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/eventNotification"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/eventnotificationconfigurations/{eventTypeId}": {
"get": {
"tags": [
"Event notification configuration"
],
"description": "__Activity name :__ GetEventNotificationConfigurationByPayrollAdministrationIdAndEventTypeId\n\nGet the details of an event notification configuration.\n",
"summary": "Details of an event notification configuration for a payroll administration",
"operationId": "GetEventNotificationConfigurationByPayrollAdministrationIdAndEventTypeId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/eventTypeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/eventNotification"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Event notification configuration"
],
"description": "__Activity name :__ PutEventNotificationConfigurationByPayrollAdministrationIdAndEventTypeId\n\nEdit the event notification configuration.\n",
"summary": "Edit an event notification configuration for a payroll administration",
"operationId": "PutEventNotificationConfigurationByPayrollAdministrationIdAndEventTypeId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/eventTypeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/eventNotificationPut"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/eventNotification"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Event notification configuration"
],
"description": "__Activity name :__ DeleteEventNotificationConfigurationByPayrollAdministrationIdAndEventTypeId\n\nDelete an existing event notification configuration\n",
"summary": "Delete an event notification configuration for a payroll administration",
"operationId": "DeleteEventNotificationConfigurationByPayrollAdministrationIdAndEventTypeId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/eventTypeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/eventnotificationconfigurations": {
"get": {
"tags": [
"Event notification configuration"
],
"description": "__Activity name :__ GetEventNotificationConfigurationsByProviderId\n\nGet a list of the notification configurations for certain events for a provider. Currently its only possible to configure email recipients for an event notification.\n\n__Note:__ Event notifications can be configured on payroll administration and provider level. This endpoint returns the provider level value or no value if none is registred at providerlevel.\n",
"summary": "The event notification configuration for a provider",
"operationId": "GetEventNotificationConfigurationsByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/eventNotification"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/eventnotificationconfigurations/{eventTypeId}": {
"get": {
"tags": [
"Event notification configuration"
],
"description": "__Activity name :__ GetEventNotificationConfigurationByProviderIdAndEventTypeId\n\nGet the details of an event notification configuration.\n",
"summary": "Details of an event notification configuration for a provider",
"operationId": "GetEventNotificationConfigurationByProviderIdAndEventTypeId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/eventTypeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/eventNotification"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Event notification configuration"
],
"description": "__Activity name :__ PutEventNotificationConfigurationByProviderIdAndEventTypeId\n\nEdit the event notification configuration.\n",
"summary": "Edit an event notification configuration for a provider",
"operationId": "PutEventNotificationConfigurationByProviderIdAndEventTypeId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/eventTypeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/eventNotificationPut"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/eventNotification"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Event notification configuration"
],
"description": "__Activity name :__ DeleteEventNotificationConfigurationByProviderIdAndEventTypeId\n\nDelete an existing event notification configuration\n",
"summary": "Delete an event notification configuration for a provider",
"operationId": "DeleteEventNotificationConfigurationByProviderIdAndEventTypeId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/eventTypeId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/applications/{applicationId}/authorizations": {
"get": {
"tags": [
"Marketplace"
],
"description": "__Activity name :__ GetApplicationAuthorizationsByApplicationId\n\nGet the authorizations of the application.\nWe expose which activities are accessable by the application and which \"rechten\" and \"producten\" are required for the user/employer to enable those activities.\n",
"summary": "Authorizations for the application",
"operationId": "GetApplicationAuthorizationsByApplicationId",
"parameters": [
{
"$ref": "#/components/parameters/applicationId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/applicationAuthorizations"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/applications/{applicationId}/logo": {
"get": {
"tags": [
"Marketplace"
],
"description": "__Activity name :__ GetApplicationLogo\n\nThis activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.\n\n__Caching:__ This resource changes very infrequently and can be cached for a longer time.\n\nGet the logo of the application. In case no logo is know the service will return a 404.",
"summary": "Download the application logo",
"operationId": "GetApplicationLogo",
"parameters": [
{
"$ref": "#/components/parameters/applicationId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/jpg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/applications": {
"get": {
"tags": [
"Marketplace"
],
"description": "__Activity name:__ GetAvailableApplicationsByEmployerId
List of all the applications and premium modules available to the employer.
\n",
"summary": "List of all the applications available to the employer",
"operationId": "GetAvailableApplicationsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/application"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/applications/{applicationId}/users": {
"get": {
"tags": [
"Marketplace"
],
"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.
\n",
"summary": "List of all the users linking the applications and the employer",
"operationId": "GetLinkedUsersByEmployerIdAndApplicationId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/applicationId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/linkedUsers-2"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/applications/{applicationId}/registerInterest\"": {
"post": {
"tags": [
"Marketplace"
],
"description": "__Activity name :__ PostRegisterInterestByEmployerIdAndApplicationId\n\nRegister the interest for the given marketplace entry (product) for the given employer\n\n__Metadata :__ No metadata\n\n__Defaults :__ No default values \n",
"summary": "Register a users interest for a marketplace entry",
"operationId": "PostRegisterInterestByEmployerIdAndApplicationId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/applicationId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Application interest",
"required": true,
"content": {
"application/json;version=2020-03-16": {
"schema": {
"$ref": "#/components/schemas/registerInterest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/auditTrail/employerData": {
"get": {
"tags": [
"Audit trail"
],
"description": "__Activity name :__ GetEmployerDataAuditTrailByEmployerId\n\nGet the mutations for the all the tables linked to the employer containing employer-related data.\n",
"summary": "Get the employer data audit trail",
"operationId": "GetEmployerDataAuditTrailByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/startDateRequired"
},
{
"$ref": "#/components/parameters/endDateRequired"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employerAuditTrail"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/auditTrail/employeeData": {
"get": {
"tags": [
"Audit trail"
],
"description": "__Activity name :__ GetEmployeeDataAuditTrailByEmployerId\n\nGet the mutations for the all the tables linked to the employee (this includes employment and underlying entities).\n",
"summary": "Get the employee data audit trail",
"operationId": "GetEmployeeDataAuditTrailByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/startDateRequired"
},
{
"$ref": "#/components/parameters/endDateRequired"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employeeAuditTrail"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/auditTrail/PayrollPeriodData": {
"get": {
"tags": [
"Audit trail"
],
"description": "__Activity name :__ GetPayrollPeriodDataAuditTrailByPayrollAdministrationId\n\nGet the audit trail for the payroll period data. \nThis endpoint requires either the set of query parameters `startDate` and `endDate` or the query parameter `payrollPeriodId` to be set. Request with none or all of these three query parameters are not supported.\n",
"summary": "Get payroll period data audit trail",
"operationId": "GetPayrollPeriodDataAuditTrailByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/startDateOptional"
},
{
"$ref": "#/components/parameters/endDateOptional"
},
{
"$ref": "#/components/parameters/payrollPeriodId-6"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollPeriodDataAuditTrail"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/applicationset/providers/employers/{employerId}/applicationsets": {
"get": {
"tags": [
"Applicationsets"
],
"description": "__Activity name:__ GetEmployerApplicationsetsByEmployerId
Get the list of Applicationsets for an employer.
\n",
"summary": "List of applicationsets for an employer",
"operationId": "GetEmployerApplicationsetsByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/applicationSet"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Applicationsets"
],
"description": "__Activity name:__ PostApplicationSetByEmployerId
Create an applicationset for an employer.
\n",
"summary": "Create an applicationset for an employer",
"operationId": "PostApplicationSetByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Applicationset to add to the employer.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/applicationSet"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/applicationSet"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/applicationset/providers/employers/applicationsets/{applicationSetId}": {
"put": {
"tags": [
"Applicationsets"
],
"description": "__Activity name:__ PutEmployerApplicationSetByApplicationSetId\n\n\n Edit the details for an applicationset.\n",
"summary": "Edit the details of an applicationset",
"operationId": "PutEmployerApplicationSetByApplicationSetId",
"parameters": [
{
"$ref": "#/components/parameters/applicationSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Applicationset to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/applicationSetPut"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/applicationSet"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Applicationsets"
],
"description": "__Activity name:__ DeleteEmployerApplicationSetByApplicationSetId\n\nDelete an applicationset for the employer\n",
"summary": "Delete a specific applicationset",
"operationId": "DeleteEmployerApplicationSetByApplicationSetId",
"parameters": [
{
"$ref": "#/components/parameters/applicationSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/applicationset/providers/{providerId}/applicationsets": {
"get": {
"tags": [
"Applicationsets"
],
"description": "__Activity name:__ GetApplicationsetsByProviderId
Get the list of Applicationsets for a provider.
\n",
"summary": "List of applicationsets for a provider",
"operationId": "GetApplicationsetsByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/applicationSet"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Applicationsets"
],
"description": "__Activity name:__ PostApplicationSetByProviderId
Create an applicationset for a provider.
\n",
"summary": "Create an applicationset for a provider",
"operationId": "PostApplicationSetByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Applicationset to add to the provider.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/applicationSet"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/applicationSet"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/applicationset/providers/applicationsets/{applicationSetId}": {
"put": {
"tags": [
"Applicationsets"
],
"description": "__Activity name:__ PutProviderApplicationSetByApplicationSetId\n\n\n Edit the details for an applicationset.\n",
"summary": "Edit the details of an applicationset",
"operationId": "PutProviderApplicationSetByApplicationSetId",
"parameters": [
{
"$ref": "#/components/parameters/applicationSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Applicationset to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/applicationSetPut"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/applicationSet"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Applicationsets"
],
"description": "__Activity name:__ DeleteProviderApplicationSetByApplicationSetId\n\nDelete an applicationset for the provider\n",
"summary": "Delete a specific applicationset",
"operationId": "DeleteProviderApplicationSetByApplicationSetId",
"parameters": [
{
"$ref": "#/components/parameters/applicationSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/applicationset/users/{userId}/applicationsets": {
"get": {
"tags": [
"Applicationsets"
],
"description": "__Activity name:__ GetApplicationsetsByUserId
Get the list of Applicationsets for a user.
\n",
"summary": "List of applicationsets for a user",
"operationId": "GetApplicationsetsByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/applicationSet"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Applicationsets"
],
"description": "__Activity name:__ PostApplicationSetByUserId
Create an applicationset for a user.
\n",
"summary": "Create an applicationset for a user",
"operationId": "PostApplicationSetByUserId",
"parameters": [
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Applicationset to add to the user.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/applicationSet"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/applicationSet"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/applicationset/users/applicationsets/{applicationSetId}": {
"put": {
"tags": [
"Applicationsets"
],
"description": "__Activity name:__ PutUserApplicationSetByApplicationSetId\n\n\n Edit the details for an applicationset.\n",
"summary": "Edit the details of an applicationset for a user",
"operationId": "PutUserApplicationSetByApplicationSetId",
"parameters": [
{
"$ref": "#/components/parameters/applicationSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Applicationset to edit.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/applicationSetPut"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/applicationSet"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Applicationsets"
],
"description": "__Activity name:__ DeleteUserApplicationSetByApplicationSetId\n\nDelete an applicationset for the user\n",
"summary": "Delete a specific applicationset for a user",
"operationId": "DeleteUserApplicationSetByApplicationSetId",
"parameters": [
{
"$ref": "#/components/parameters/applicationSetId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/applicationset/applicationsets/general": {
"get": {
"tags": [
"Applicationsets"
],
"description": "__Activity name:__ GetLoketApplicationsetsByBearerToken
Get the list of Applicationsets for an employer.
\n",
"summary": "List of applicationsets provided by the Loket application",
"operationId": "GetLoketApplicationsetsByBearerToken",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/applicationSet"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/{employmentId}/payrollSimulatorData": {
"get": {
"tags": [
"Payroll simulator"
],
"description": "__Activity name :__ GetPayrollSimulatorDataByEmploymentId\n\nGet an overview of the data used in a payroll simulation\n",
"summary": "Overview of the data used in a payroll simulation",
"operationId": "GetPayrollSimulatorDataByEmploymentId",
"parameters": [
{
"$ref": "#/components/parameters/employmentId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/payrollSimulatorData"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/emailidentities": {
"get": {
"tags": [
"EmailIdentities"
],
"description": "__Activity name:__ GetEmailIdentitiesByProviderId
Get the list of EmailIdentities for a provider.
\n",
"summary": "List of EmailIdentities for a provider",
"operationId": "GetEmailIdentitiesByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailIdentity"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"EmailIdentities"
],
"description": "__Activity name:__ PostEmailIdentityByProviderId
Create an EmailIdentity for a provider.
\n",
"summary": "Create an EmailIdentity for a provider",
"operationId": "PostEmailIdentityByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "EmailIdentity to add to the provider.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/EmailIdentity"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/EmailIdentity"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/emailidentities/{emailIdentityId}": {
"delete": {
"tags": [
"EmailIdentities"
],
"description": "__Activity name:__ DeleteProviderEmailIdentityByEmailIdentityId
Delete an EmailIdentity for a provider. An EmailIdentity can only be deleted when it's not used in an emailTemplate.
\n",
"summary": "Delete an EmailIdentity for a provider",
"operationId": "DeleteProviderEmailIdentityByEmailIdentityId",
"parameters": [
{
"$ref": "#/components/parameters/emailIdentityId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/emailidentities/{emailIdentityId}/sendtestemail": {
"post": {
"tags": [
"EmailIdentities"
],
"description": "__Activity name:__ PostSendProviderTestemailByEmailIdentityId
Send an email to test the email identity configuration.
\n",
"summary": "Provider emailIdentity test email",
"operationId": "PostSendProviderTestemailByEmailIdentityId",
"parameters": [
{
"$ref": "#/components/parameters/emailIdentityId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/EmailIdentityTestEmail"
}
}
}
},
"responses": {
"201": {
"description": "OK. The test email has been sent."
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/{providerId}/emailidentities/verify": {
"post": {
"tags": [
"EmailIdentities"
],
"description": "__Activity name:__ PostVerifyEmailIdentityByProviderId
Verify an EmailIdentity for a provider. The verficationstatus will we saved and used by Loket when sending email.
\n",
"summary": "Verify an EmailIdentity for a provider",
"operationId": "PostVerifyEmailIdentityByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "EmailIdentity to Verify.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/EmailIdentity"
}
}
}
},
"responses": {
"201": {
"description": "Verified",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/EmailIdentity"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/emailidentities": {
"get": {
"tags": [
"Email Identities"
],
"description": "__Activity name:__ GetEmailIdentitiesByEmployerId
Get the list of EmailIdentities for an employer.
\n",
"summary": "List of EmailIdentities for an employer",
"operationId": "GetEmailIdentitiesByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailIdentity"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Email Identities"
],
"description": "__Activity name:__ PostEmailIdentityByEmployerId
Create an EmailIdentity for an employer.
\n",
"summary": "Create an EmailIdentity for an employer",
"operationId": "PostEmailIdentityByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "EmailIdentity to add to the employer.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/EmailIdentity"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/EmailIdentity"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/emailidentities/{emailIdentityId}": {
"delete": {
"tags": [
"Email Identities"
],
"description": "__Activity name:__ DeleteEmployerEmailIdentityByEmailIdentityId
Delete an EmailIdentity for an employer. An EmailIdentity can only be deleted when it's not used in an emailTemplate.
\n",
"summary": "Delete an EmailIdentity for an employer",
"operationId": "DeleteEmployerEmailIdentityByEmailIdentityId",
"parameters": [
{
"$ref": "#/components/parameters/emailIdentityId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/emailidentities/{emailIdentityId}/sendtestemail": {
"post": {
"tags": [
"Email Identities"
],
"description": "__Activity name:__ PostSendEmployerTestemailByEmailIdentityId
Send an email to test the email identity configuration.
\n",
"summary": "Employer emailIdentity test email",
"operationId": "PostSendEmployerTestemailByEmailIdentityId",
"parameters": [
{
"$ref": "#/components/parameters/emailIdentityId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/EmailIdentityTestEmail"
}
}
}
},
"responses": {
"201": {
"description": "OK. The test email has been sent."
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/emailidentities/verify": {
"post": {
"tags": [
"Email Identities"
],
"description": "__Activity name:__ PostVerifyEmailIdentityByEmployerId
Verify an EmailIdentity for an employer. The verficationstatus will we saved and used by Loket when sending email.
\n",
"summary": "Verify an EmailIdentity for an employer",
"operationId": "PostVerifyEmailIdentityByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "EmailIdentity to Verify.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/EmailIdentity"
}
}
}
},
"responses": {
"201": {
"description": "Verified",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/EmailIdentity"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/conceptemployees/import/{payrollAdministrationId}": {
"patch": {
"tags": [
"Employee import"
],
"description": "__Activity name :__ PatchImportConceptEmployeesByPayrollAdministrationId\n\n__Metadata:__ No metadata\n\nCurrently supported file is the payroll tax return XML (year 2022 or later).\n",
"summary": "Import concept employees via a file",
"operationId": "PatchImportConceptEmployeesByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "xml file to be uploaded.",
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/patchResponse"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"413": {
"$ref": "#/components/responses/requestEntityTooLarge"
},
"415": {
"$ref": "#/components/responses/unsupportedMediaType"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrollAdministrations/{payrollAdministrationId}/import/employees": {
"post": {
"tags": [
"Employee import"
],
"description": "__Activity name :__ PostEmployeeImportDataByPayrollAdministrationId\n\n\nImports a csv file containing employee records.\n",
"summary": "Import employee via a csv file",
"operationId": "PostEmployeeImportDataByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/year-4"
},
{
"$ref": "#/components/parameters/period-2"
},
{
"$ref": "#/components/parameters/payslipType-2"
}
],
"requestBody": {
"description": "csv file to be uploaded.",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/importFile"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/collectiveAction-2"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"413": {
"$ref": "#/components/responses/requestEntityTooLarge"
},
"415": {
"$ref": "#/components/responses/unsupportedMediaType"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/employees/employments/WageProposals": {
"get": {
"tags": [
"Wage proposal"
],
"summary": "List of wage proposals for the employments of an employer",
"operationId": "GetWageProposalsByEmployerId",
"description": "__Activity name :__ GetWageProposalsByEmployerId\n\nReturns a list of wage proposals for the employments of the employer.\nA wage proposal is created when an employment reaches the criteria set for the next tier of wage. \nE.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.\nVia 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.\n",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/wageProposalObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/employees/employments/WageProposals": {
"patch": {
"tags": [
"Wage proposal"
],
"description": "__Activity name :__ PatchWageProposalsByWageProposalId\n\nAccept or reject wage proposals\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"operationId": "PatchWageProposalsByWageProposalId",
"summary": "Accept or reject wage proposals",
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/wageProposalPatchObject"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrollAdministrations/{payrollAdministrationId}/mdvNotifications": {
"patch": {
"tags": [
"Mdv notifications"
],
"summary": "MDV notifications",
"description": "__Activity name :__ PatchMdvNotificationsByPayrollAdministrationId\n\nMdv notifications\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
}
],
"operationId": "PatchMdvNotificationsByPayrollAdministrationId",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MdvMeldingen"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/proforma/initialize": {
"post": {
"tags": [
"Proforma"
],
"description": "__Activity name:__ PostInitializeProformaByEmployerId\n\nInitialize a proforma environment (request the copying of data from live to proforma).\n\n__Metadata :__ None\n\n__Defaults :__ None\n",
"summary": "Initialize the proforma environment",
"operationId": "PostInitializeProformaByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/initializeProforma"
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/{employerId}/proforma": {
"get": {
"tags": [
"Proforma"
],
"description": "__Activity name :__ GetProformaStatusByEmployerId\n\nGet the status of proforma for this employer\n",
"summary": "Get the status of proforma for this employer",
"operationId": "GetProformaStatusByEmployerId",
"parameters": [
{
"$ref": "#/components/parameters/employerId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/proformaStatus"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/workRelatedCostsSchemeFinancials": {
"get": {
"tags": [
"Work related costs scheme"
],
"description": "__Activity name:__ GetWorkRelatedCostsSchemeFinancialsByPayrollAdministrationId
Get the list of work related costs scheme financials (WKR) for a specific payroll administration
\n",
"summary": "List of work related costs scheme (WKR)",
"operationId": "GetWorkReleatedCostsSchemeFinancialsByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/workRelatedCostsSchemeFinancialsObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"post": {
"tags": [
"Work related costs scheme"
],
"description": "__Activity name:__ PostWorkRelatedCostsSchemeFinancialByPayrollAdministrationId
Create a new work related costs scheme financial (WKR) record
__Metadata :__ No metadata
__Defaults :__ There is NO /defaults endpoint available for this resource.
\n",
"summary": "Create a work related costs scheme financial (WKR) record",
"operationId": "PostWorkRelatedCostsSchemeFinancialByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/journalProfileId-2"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "work related costs scheme financial (WKR)",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/workRelatedCostsSchemeFinancialsObject"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/workRelatedCostsSchemeFinancialsObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/workRelatedCostsSchemeFinancials/{workRelatedCostsSchemeFinancialId}": {
"get": {
"tags": [
"Work related costs scheme"
],
"description": "__Activity name:__ GetWorkRelatedCostsSchemeFinancialByWorkRelatedCostsSchemeFinancialId\n\nGet the details of a work related costs scheme financial (WKR) record\n",
"summary": "Details of a work related costs scheme financial (WKR)",
"operationId": "GetWorkRelatedCostsSchemeFinancialByWorkRelatedCostsSchemeFinancialId",
"parameters": [
{
"$ref": "#/components/parameters/workRelatedCostsSchemeFinancialId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/workRelatedCostsSchemeFinancialsObject"
}
}
}
]
}
}
},
"headers": {
"ETag": {
"$ref": "#/components/headers/ETag"
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"put": {
"tags": [
"Work related costs scheme"
],
"description": "__Activity name:__ PutWorkRelatedCostsSchemeFinancialByWorkRelatedCostsSchemeFinancialId\n\nEdit the details of a work related costs scheme financial record\n\n* No metadata required\n",
"summary": "Edit the details of a work related costs scheme financial record",
"operationId": "PutWorkRelatedCostsSchemeFinancialByWorkRelatedCostsSchemeFinancialId",
"parameters": [
{
"$ref": "#/components/parameters/workRelatedCostsSchemeFinancialId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"requestBody": {
"description": "Work related costs scheme",
"required": true,
"content": {
"application/json;version=2018-01-01": {
"schema": {
"$ref": "#/components/schemas/workRelatedCostsSchemeFinancialsObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/workRelatedCostsSchemeFinancialsObject"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"409": {
"$ref": "#/components/responses/conflict"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"Work related costs scheme"
],
"description": "__Activity name:__ DeleteWorkRelatedCostsSchemeFinancialByWorkRelatedCostsSchemeFinancialId\n\nDelete a Work related costs scheme financial\n",
"summary": "Delete a work related costs scheme financial",
"operationId": "DeleteWorkRelatedCostsSchemeFinancialByWorkRelatedCostsSchemeFinancialId",
"parameters": [
{
"$ref": "#/components/parameters/workRelatedCostsSchemeFinancialId"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/deleteEmptyResponse"
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/workRelatedCostsSchemeMatrix": {
"get": {
"tags": [
"Work related costs scheme"
],
"description": "__Activity name:__ GetWorkRelatedCostsSchemeMatrixByPayrollAdministrationId
Get the work related costs scheme matrix data (WKR) for a specific payroll administration
\n",
"summary": "Work related costs scheme matrix (WKR)",
"operationId": "GetWorkRelatedCostsSchemeMatrixByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/orderBy"
},
{
"$ref": "#/components/parameters/pageNumber"
},
{
"$ref": "#/components/parameters/pageSize"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/workRelatedCostsSchemeMatrixObject"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/workRelatedCostsSchemeReport": {
"get": {
"tags": [
"Work related costs scheme"
],
"description": "__Activity name :__ GetWorkRelatedCostsSchemeReportByPayrollAdministrationId\n\nAcquire the reports for work related costs scheme at the payroll administration level.\n",
"summary": "Download the work related costs scheme report",
"operationId": "GetWorkRelatedCostsSchemeReportByPayrollAdministrationId",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/payrollAdministrationId"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/reportYear"
},
{
"$ref": "#/components/parameters/payrollComponentSet-3"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/provider/providers/{providerId}/employers/modules": {
"get": {
"tags": [
"Provider employer reports"
],
"description": "__Activity name :__ GetEmployersModulesByProviderId",
"summary": "List modules per employer for all employers of the provider",
"operationId": "GetEmployersModulesByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/modules"
},
{
"$ref": "#/components/parameters/moduleIds"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/modulesEmployersReport"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/provider/providers/{providerId}/payrollAdministrations/YearEndStatements": {
"get": {
"tags": [
"Provider payroll administration reports"
],
"description": "__Activity name :__ GetpayrollAdministrationsYearEndStatementsByProviderId",
"summary": "List of year-end statements for all payroll administrations of the provider",
"operationId": "GetpayrollAdministrationsYearEndStatementsByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/reportYear-3"
},
{
"$ref": "#/components/parameters/referenceDateRequired"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/YearEndStatementsReport"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/provider/providers/{providerId}/payrollAdministrations/Payslips": {
"get": {
"tags": [
"Provider payroll administration reports"
],
"description": "__Activity name :__ GetPayrollAdministrationsNumberOfPayslipsByProviderId",
"summary": "List of payslips per type for all payroll administrations of the provider",
"operationId": "GetPayrollAdministrationsNumberOfPayslipsByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/startDateRequired"
},
{
"$ref": "#/components/parameters/endDateRequired"
},
{
"$ref": "#/components/parameters/testYear"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/paySlips"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/provider/providers/{providerId}/payrollAdministrations/employmentTurnover": {
"get": {
"tags": [
"Provider payroll administration reports"
],
"description": "__Activity name :__ GetPayrollAdministrationsEmploymentTurnoverByProviderId",
"summary": "List of employment turnover per payroll administration for the provider",
"operationId": "GetPayrollAdministrationsEmploymentTurnoverByProviderId",
"parameters": [
{
"$ref": "#/components/parameters/providerId"
},
{
"$ref": "#/components/parameters/startDateRequired"
},
{
"$ref": "#/components/parameters/endDateRequired"
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json;version=2018-01-01": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageWarning-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employmentTurnover"
}
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestCollection"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
},
"/payrolltaxreturn/providers/employers/payrolladministrations/payrolltaxreturns/{payrollTaxReturnId}/report": {
"get": {
"tags": [
"Reports new style"
],
"summary": "Download the overview report of a payroll tax return",
"description": "__Activity name :__ GetPayrollTaxReturnReportByPayrollTaxreturnId\n\nDownload the payroll tax return report. (New style)\n\n\nThe report is also available as a 'totalsonly' report at: '/payrolltaxreturn/providers/employers/payrolladministrations/payrolltaxreturns/{payrollTaxReturnId}/reporttotalsonly'\n",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/accept"
},
{
"$ref": "#/components/parameters/payrollTaxReturnId"
}
],
"operationId": "GetPayrollTaxReturnReportByPayrollTaxreturnId",
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/badRequestDetail"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/notFound"
},
"500": {
"$ref": "#/components/responses/internalServerError"
}
}
}
}
},
"components": {
"parameters": {
"authorization": {
"name": "Authorization",
"in": "header",
"description": "A valid Bearer token for authorizing the request.",
"required": true,
"schema": {
"type": "string",
"example": "Bearer ",
"pattern": "^Bearer\\s[\\w-]+$"
}
},
"accept": {
"name": "Accept",
"in": "header",
"description": "The accept header is used to influence what type of output is returned and in most cases the version of the output",
"required": true,
"schema": {
"type": "string",
"example": "application/json;version=2018-01-01"
}
},
"employeeId": {
"name": "employeeId",
"in": "path",
"description": "The unique identifier of the employee",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"filter": {
"name": "filter",
"in": "query",
"description": "Filter the collection",
"required": false,
"schema": {
"type": "string",
"example": "cancellationPeriodTimeUnit.key eq 4"
}
},
"orderBy": {
"name": "orderBy",
"in": "query",
"description": "Order the collection on one or more fields",
"required": false,
"schema": {
"type": "string",
"pattern": "^-?\\w+(,-?\\w+)*$",
"example": "-companyName,address.houseNumber"
}
},
"pageNumber": {
"name": "pageNumber",
"in": "query",
"description": "Specifies which page should be returned",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 1,
"example": 2
}
},
"pageSize": {
"name": "pageSize",
"in": "query",
"description": "Specifies the number of objects per page",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 250,
"example": 20
}
},
"absenceId": {
"name": "absenceId",
"in": "path",
"description": "The unique identifier of an absence",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"absenceProgressId": {
"name": "absenceProgressId",
"in": "path",
"description": "The unique identifier of an absence progress",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"absencecontactHistoryId": {
"name": "absencecontactHistoryId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"employerId": {
"name": "employerId",
"in": "path",
"description": "The unique identifier of the employer",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"startYearMonth": {
"name": "startYearMonth",
"in": "query",
"description": "The start year and month of the absence overview",
"required": true,
"schema": {
"type": "string",
"example": "202401"
}
},
"endYearMonth": {
"name": "endYearMonth",
"in": "query",
"description": "The end year and month of the absence overview",
"required": true,
"schema": {
"type": "string",
"example": "202412"
}
},
"payrollAdministrationId": {
"name": "payrollAdministrationId",
"in": "path",
"description": "The unique identifier of an administration",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"yearId": {
"name": "yearId",
"in": "path",
"description": "The guid of the payroll year",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"automaticPayrollDateId": {
"name": "automaticPayrollDateId",
"in": "path",
"required": true,
"description": "The unique identifier of the automatic payroll date.\n",
"schema": {
"type": "string",
"format": "uuid",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
}
},
"nonPayrollAdministrationId": {
"name": "nonPayrollAdministrationId",
"in": "path",
"description": "The unique identifier of an administration",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"payrollComponentSetId": {
"name": "payrollComponentSetId",
"in": "path",
"description": "The unique identifier of the payroll component set",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"providerId": {
"name": "providerId",
"in": "path",
"description": "The unique identifier of a provider",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"year": {
"name": "year",
"in": "path",
"description": "The payroll year",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"maxLength": 4,
"example": 2018
}
},
"collectiveActionId": {
"name": "collectiveActionId",
"in": "path",
"description": "The unique identifier of the collective action",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"referenceDateRequired": {
"name": "referenceDate",
"in": "query",
"description": "Set a reference date for choosing the date dependent data.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2022-01-01"
}
},
"includeEmploymentsThatEndedBeforeReferenceDate": {
"name": "includeEmploymentsThatEndedBeforeReferenceDate",
"in": "query",
"description": "If set to true records with an enddate before the reference will be included in the output.",
"example": false,
"required": true,
"schema": {
"type": "boolean"
}
},
"reportYear": {
"name": "reportYear",
"in": "query",
"description": "A valid year for which the information is requested.",
"example": 2023,
"required": true,
"schema": {
"type": "integer"
}
},
"reportYearNotRequired": {
"name": "reportYear",
"in": "query",
"description": "A valid year for which the information is requested.",
"example": 2023,
"required": false,
"schema": {
"type": "integer"
}
},
"startPeriodNotRequired": {
"name": "startPeriod",
"in": "query",
"description": "First period (=from) of the requested timebox. Use the format 'YYYYPP'",
"example": 201901,
"required": false,
"schema": {
"type": "integer",
"minimum": 0
}
},
"endPeriodNotRequired": {
"name": "endPeriod",
"in": "query",
"description": "Last period (=up to and including) of the requested timebox. Use the following 'YYYYPP'",
"example": 201912,
"required": false,
"schema": {
"type": "integer",
"minimum": 0
}
},
"reportTypeAccumulationsAndBalances": {
"name": "reportType",
"in": "query",
"description": "The type of report that is requested.",
"example": "baseForCalculationBalancesAtStartOfYear",
"required": true,
"schema": {
"type": "string",
"enum": [
"baseForCalculationBalancesAtStartOfYear",
"leaveBalancesAtStartOfYear",
"leaveAccrualWithinYear"
]
}
},
"includeEmploymentsThatEndedBeforeStartOfTheYear": {
"name": "includeEmploymentsThatEndedBeforeStartOfTheYear",
"in": "query",
"description": "If set to true employments with an enddate before the start of the reportYear will be included in the output.",
"example": false,
"required": false,
"schema": {
"type": "boolean"
}
},
"reportTypeAccumulatedJournalRunResults": {
"name": "reportType",
"in": "query",
"description": "The type of report that is requested.",
"example": "nonAggregated",
"required": true,
"schema": {
"type": "string",
"enum": [
"nonAggregated",
"aggregatedPerGeneralLedgerAccount"
]
}
},
"groupingTypeAccumulatedJournalRunResults": {
"name": "groupingType",
"in": "query",
"description": "The type of grouping that is requested. This affects the way the data is presented within the given report.",
"example": "perPeriod",
"required": true,
"schema": {
"type": "string",
"enum": [
"perPeriod",
"perDistributionUnit",
"perPeriodPerDistributionUnit"
]
}
},
"startPeriod": {
"name": "startPeriod",
"in": "query",
"description": "First period (=from) of the requested timebox. Use the format 'YYYYPP'",
"example": 201901,
"required": true,
"schema": {
"type": "integer",
"minimum": 0
}
},
"endPeriod": {
"name": "endPeriod",
"in": "query",
"description": "Last period (=up to and including) of the requested timebox. Use the following 'YYYYPP'",
"example": 201912,
"required": true,
"schema": {
"type": "integer",
"minimum": 0
}
},
"reportJournalNumber": {
"name": "reportJournalNumber",
"in": "query",
"description": "Dagboeknummer.",
"example": 123,
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"reportVoucherNumber": {
"name": "reportVoucherNumber",
"in": "query",
"description": "Boekstuknummer.",
"required": true,
"example": 456,
"schema": {
"type": "integer",
"format": "int32"
}
},
"reportDescription": {
"name": "reportDescription",
"in": "query",
"description": "Omschrijving to be shown on the overview.",
"example": 123,
"required": false,
"schema": {
"type": "string"
}
},
"financialYear": {
"name": "financialYear",
"in": "query",
"description": "fiscal year.",
"required": true,
"example": 2023,
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1900,
"maximum": 9999
}
},
"period": {
"name": "period",
"in": "query",
"description": "fiscal period.",
"required": true,
"example": 12,
"schema": {
"type": "integer",
"format": "int32",
"minimum": 0
}
},
"date": {
"name": "date",
"in": "query",
"description": "Date",
"example": "2023-01-01",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
"payrollPeriodId": {
"name": "payrollPeriodId",
"in": "query",
"description": "The payrollperiod the report will return data for. Use the format 'YYYYPP'",
"example": 201901,
"required": true,
"schema": {
"type": "integer",
"minimum": 0
}
},
"employmentId": {
"name": "employmentId",
"in": "path",
"description": "The unique identifier of the employment",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"payrollPeriodId-2": {
"name": "payrollPeriodId",
"in": "path",
"description": "The unique identifier of the payroll period",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"payslipType": {
"name": "payslipType",
"in": "query",
"description": "Controles which payroll period data is returned either for the normal payslip of the tarif payslip.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"payrollComponentSet": {
"name": "payrollComponentSet",
"in": "query",
"description": "A predefined set of payroll components to filter which payroll components are returned.\n\n__Note:__ Either `payrollComponentSet` or `payrollComponentCategory` or `payrollComponentId` must have a value.",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
"payrollComponentCategory": {
"name": "payrollComponentCategory",
"in": "query",
"description": "A predefined category of payroll components to filter which payroll components are returned.\n\n__Note:__ Either `payrollComponentSet` or `payrollComponentCategory` or `payrollComponentId` must have a value. ",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
"payrollComponentId": {
"name": "payrollComponentId",
"in": "query",
"description": "A payroll components to filter on.\n\n__Note:__ Either `payrollComponentSet` or `payrollComponentCategory` or `payrollComponentId` must have a value.\n\nThis parameter will soon become available.",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
"payrollPeriodId-3": {
"name": "payrollPeriodId",
"in": "path",
"description": "The unique identifier of the payroll period.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"example": 202510
}
},
"smartPasteId": {
"name": "smartPasteId",
"in": "path",
"description": "The unique identifier of the Smart Paste action.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "e94fe740-f155-4f91-b947-0f9775cbd59a"
}
},
"employerId-2": {
"name": "employerId",
"in": "query",
"description": "The unique identifier of the employer",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"example": "0d5327ae-0298-49ae-93b7-19cc9d2acb2f"
},
"payrollPeriodIdQuery": {
"name": "payrollPeriodId",
"in": "query",
"description": "The unique identifier of the payroll period",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"processingMethod": {
"name": "processingMethod",
"in": "query",
"description": "The method of processing data when existing values are found. (overwrite, do not overwrite, add up)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"workflowTemplateId": {
"name": "workflowTemplateId",
"in": "path",
"required": true,
"description": "The unique identifier of the workflow template.",
"schema": {
"type": "string",
"format": "uuid"
}
},
"workflowTriggerId": {
"name": "workflowTriggerId",
"in": "path",
"required": true,
"description": "The unique identifier of the workflow trigger.",
"schema": {
"type": "string",
"format": "uuid"
}
},
"workflowTriggerMappingId": {
"name": "workflowTriggerMappingId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"workflowId": {
"name": "workflowId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"leaveRequestId": {
"name": "leaveRequestId",
"in": "path",
"description": "The unique identifier of the leave request",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"employmentIdQuery": {
"name": "employmentId",
"in": "query",
"description": "The id of the employment.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"workflowIds": {
"name": "workflowIds",
"in": "query",
"description": "WorkflowIds for which the attachment is available. This parameter may be included multiple times to indicate multiple workflowIds.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"workflowFilters": {
"name": "workflowFilters",
"in": "query",
"description": "Dynamic workflow filter.\nIf a parameter is provided multiple times, only the first occurrence is processed.",
"required": false,
"style": "deepObject",
"schema": {
"type": "object",
"properties": {
"leaveRequestId": {
"type": "string",
"format": "uuid",
"description": "Filter on leave request id. This filter is only supported for leave request workflows."
}
}
},
"example": {
"leaveRequestId": "0209c6c1-803b-40b1-ab68-fd7510dbd787"
}
},
"acceptWithExport": {
"name": "Accept",
"in": "header",
"description": "The accept header is used to influence what type of output is returned and in most cases the version of the output\n\nThe default option is `application/json;version=yyyy-MM-dd`. For the export functionality two other options are supported:\n * text/csv;version=yyyy-MM-dd\n * application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;version=yyyy-MM-dd",
"required": true,
"schema": {
"type": "string",
"example": "application/json;version=2018-01-01"
}
},
"X-ReportInput": {
"name": "X-ReportInput",
"in": "header",
"required": false,
"description": "Allows the user set what values are returnd in the \"export\" (csv or excel).\n",
"schema": {
"type": "string"
}
},
"employeeContactId": {
"name": "contactId",
"in": "path",
"description": "The unique identifier of the employee contact detail",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"childId": {
"name": "childId",
"in": "path",
"description": "The unique identifier of a child",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"partnerId": {
"name": "partnerId",
"in": "path",
"description": "The unique identifier of a partner",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"version": {
"name": "version",
"in": "path",
"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.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"employeeCustomFieldId": {
"name": "employeeCustomFieldId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"includeParent": {
"name": "includeParent",
"in": "query",
"description": "Determines whether the information of the parent employer should be included in the response. If not provided, this parameter defaults to `false` and the response will not include the information of the parent.",
"example": true,
"required": false,
"schema": {
"type": "boolean"
}
},
"functionId": {
"name": "functionId",
"in": "path",
"description": "The unique identifier of the function",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"departmentId": {
"name": "departmentId",
"in": "path",
"description": "The unique identifier of the department",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"customFieldId": {
"name": "customFieldId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"educationTypeId": {
"name": "educationTypeId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"educationFurtherIndicationId": {
"name": "educationFurtherIndicationId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"contractCodeId": {
"name": "contractCodeId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"benefitInKindTypeId": {
"name": "benefitInKindTypeId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"customHolidayId": {
"name": "customHolidayId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"nationalHolidayId": {
"name": "nationalHolidayId",
"in": "path",
"description": "The unique identifier of the national holiday",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"distributionUnitId": {
"name": "distributionUnitId",
"in": "path",
"description": "The unique identifier of the distribution unit",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"conceptEmployeeId": {
"name": "conceptEmployeeId",
"in": "path",
"description": "The unique identifier of the concept employee",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"deleteDocuments": {
"name": "deleteDocuments",
"in": "query",
"description": "If true, all underlying documents will be deleted.",
"example": false,
"required": false,
"schema": {
"type": "boolean"
}
},
"X-ValidateOnly": {
"name": "X-ValidateOnly",
"in": "header",
"description": "If set to true only the validations will be performed no changes will be committed.",
"required": false,
"schema": {
"type": "boolean"
}
},
"payscaleKey": {
"name": "payscaleKey",
"in": "path",
"description": "Key for specific payscale",
"required": true,
"schema": {
"type": "integer"
}
},
"paygradeKey": {
"name": "paygradeKey",
"in": "path",
"description": "Key for specific paygrade",
"required": true,
"schema": {
"type": "integer"
}
},
"date-2": {
"name": "date",
"in": "query",
"description": "A valid date (xxxx-xx-xx)",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
"contactPersonId": {
"name": "contactPersonId",
"in": "path",
"description": "The unique identifier of the concept employee contact person",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"acceptAsyncorSync": {
"name": "Accept",
"in": "header",
"description": "The accept header is used to influence what type of output is returned and in most cases the version of the output\n\nThe output of the endpoint is provided async or sync. The default option is `application/json`. These are the supported options:\n * application/json\n * text/csv\n * responseType=async;text/csv\n * responseType=async;application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
"required": true,
"schema": {
"type": "string",
"example": "responseType=async;text/csv"
}
},
"includeRead": {
"name": "includeRead",
"in": "query",
"description": "Include the read items",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"example": true
}
},
"startDateOptional": {
"name": "startDate",
"in": "query",
"description": "The start date",
"required": false,
"schema": {
"type": "string",
"pattern": "date",
"example": "2020-08-01"
}
},
"endDateOptional": {
"name": "endDate",
"in": "query",
"description": "The end date",
"required": false,
"schema": {
"type": "string",
"pattern": "date",
"example": "2020-08-31"
}
},
"notificationId": {
"name": "notificationId",
"in": "path",
"required": true,
"description": "The unique identifier of a notification",
"schema": {
"$ref": "#/components/schemas/id"
}
},
"includeExpired": {
"name": "includeExpired",
"in": "query",
"description": "Include the read items",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"example": true
}
},
"includeDescription": {
"name": "includeDescription",
"in": "query",
"required": false,
"description": "Indicates whether the description should be included in the response.\n",
"schema": {
"type": "boolean",
"default": false,
"example": true
}
},
"announcementId": {
"name": "announcementId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"referenceDate": {
"name": "referenceDate",
"in": "query",
"description": "Set a reference date for choosing the date dependent data.",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2022-01-01"
}
},
"removeEmptyLines": {
"name": "removeEmptyLines",
"in": "query",
"description": "When true and combined with a X-ReportInput header, the output only contains employments for which selected underlying data, such as wage, is available. ",
"required": false,
"schema": {
"type": "boolean",
"example": true
}
},
"includeHistoricAndFutureData": {
"name": "includeHistoricAndFutureData",
"in": "query",
"description": "If set to true, historic and future records will also be returned",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"example": true
}
},
"payrollperioddataId": {
"name": "payrollperioddataId",
"in": "path",
"description": "The unique identifier of the payroll period data",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"benefitsanddeductionsId": {
"name": "benefitsanddeductionsId",
"in": "path",
"description": "The unique identifier of the benefits and deductions data",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"collectiveLaborAgreementId": {
"name": "collectiveLaborAgreementId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"employeeEducationId": {
"name": "employeeEducationId",
"in": "path",
"description": "The unique identifier of the employee education detail",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"declarationId": {
"name": "declarationId",
"in": "path",
"description": "The unique identifier of the declaration",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"wageId": {
"name": "wageId",
"in": "path",
"description": "The unique identifier of a wage",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"referenceDateOptional": {
"name": "referenceDate",
"in": "query",
"description": "Set a reference date for choosing the date dependent data.",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2022-01-01"
}
},
"paygradeKey-2": {
"name": "paygradeKey",
"in": "query",
"description": "The Paygrade (age) to use for calculating the minimumwage. When not supplied, the age is calculated.",
"required": false,
"schema": {
"type": "integer"
}
},
"payscaleKey-2": {
"name": "payscaleKey",
"in": "query",
"description": "The Payscale to use for calculating the minimumwage The following payscales are supported:\n -1 Wettelijk minimumloon, maandloon\n -2 Wettelijk minimumloon, 4 weken\n -3 Wettelijk minimumloon, uurloon",
"required": true,
"schema": {
"type": "integer"
}
},
"includeEstimation": {
"name": "includeEstimation",
"in": "query",
"description": "include an estimation if no cost per unit records are present",
"example": true,
"required": false,
"schema": {
"type": "boolean"
}
},
"costPerHourId": {
"name": "costPerHourId",
"in": "path",
"description": "The unique identifier of the cost per hour record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"workinghoursId": {
"name": "workinghoursId",
"in": "path",
"description": "The unique identifier of the work detail",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"organizationalEntityId": {
"name": "organizationalEntityId",
"in": "path",
"description": "The unique identifier of the organizational entity",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"paymentInformationSepaId": {
"name": "paymentInformationSepaId",
"in": "path",
"description": "The unique identifier of the SEPA payment record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"paymentInformationSepaSeparatePaymentId": {
"name": "paymentInformationSepaSeparatePaymentId",
"in": "path",
"description": "The unique identifier of the SEPA payment record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"paymentInformationNonSepaId": {
"name": "paymentInformationNonSepaId",
"in": "path",
"description": "The unique identifier of the SEPA payment record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"attachmentOfEarningsId": {
"name": "attachmentOfEarningsId",
"in": "path",
"description": "The unique identifier of a record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"protectedEarningsId": {
"name": "protectedEarningsId",
"in": "path",
"description": "The unique identifier of a record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"fiscalPropertiesId": {
"name": "fiscalPropertiesId",
"in": "path",
"description": "The unique identifier of the fiscal properties record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"fiscalCompanyCarId": {
"name": "fiscalCompanyCarId",
"in": "path",
"description": "The unique identifier of the fiscal company car",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"companyCarId": {
"name": "companyCarId",
"in": "path",
"description": "The unique identifier of the company car",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"licensePlateNumber": {
"name": "licensePlateNumber",
"in": "query",
"description": "A valid vehicle registration (license plate) number.",
"example": "52LRX4",
"required": true,
"schema": {
"type": "string"
}
},
"employmentFundId": {
"name": "employmentFundId",
"in": "path",
"description": "The unique identifier of the employment fund",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"abpFundId": {
"name": "abpFundId",
"in": "path",
"description": "The unique identifier of the abp fund",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"baseforemploymentfundcalculationId": {
"name": "baseforemploymentfundcalculationId",
"in": "path",
"description": "The unique identifier of a base for employment fund calculation",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"baseforcalculationId": {
"name": "baseforcalculationId",
"in": "path",
"description": "The unique identifier of a base for calculation",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"deviatingAwfContributionId": {
"name": "deviatingAwfContributionId",
"in": "path",
"description": "The unique identifier of the Deviating AWF contribution record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"pensionBenefitId": {
"name": "pensionBenefitId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"deviatingHourlyWageId": {
"name": "deviatingHourlyWageId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"benefitInKindId": {
"name": "benefitInKindId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"customNotificationId": {
"name": "customNotificationId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"employmentCustomFieldId": {
"name": "employmentCustomFieldId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"otherPayrollVariablesId": {
"name": "otherPayrollVariablesId",
"in": "path",
"description": "The unique identifier of the other payroll variables record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"socialSecurityConfigurationId": {
"name": "socialSecurityConfigurationId",
"in": "path",
"description": "The unique identifier of the social security record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"socialSecurityBenefitId": {
"name": "socialSecurityBenefitId",
"in": "path",
"description": "The unique identifier of the social security record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"healthcareInsuranceActConfigurationId": {
"name": "healthcareInsuranceActConfigurationId",
"in": "path",
"description": "The unique identifier of the Healthcare Insurance Act record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"wachtgeldId": {
"name": "wachtgeldId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"achmeaInsuranceContractId": {
"name": "achmeaInsuranceContractId",
"in": "path",
"description": "The unique identifier of an Achmea insurance contract",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"userId": {
"name": "userId",
"in": "path",
"description": "The unique identifier of an user",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"leavePolicyId": {
"name": "leavePolicyId",
"in": "path",
"description": "The unique identifier of the leave policy",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"ageBasedLeaveId": {
"name": "ageBasedLeaveId",
"in": "path",
"description": "The unique identifier of the age based leave",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"yearsOfServiceBasedLeaveId": {
"name": "yearsOfServiceBasedLeaveId",
"in": "path",
"description": "The unique identifier of the years of service based leave",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"wageBasedLeaveId": {
"name": "wageBasedLeaveId",
"in": "path",
"description": "The unique identifier of the wage based leave",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"leavePolicyId-2": {
"name": "leavePolicyId",
"in": "path",
"description": "The unique identifier of the leave policy",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"year-2": {
"name": "year",
"in": "query",
"description": "The year",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"maxLength": 4,
"example": 2024
}
},
"month": {
"name": "month",
"in": "query",
"description": "The month",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"maxLength": 2,
"example": 7
}
},
"overridingEmploymentEndDate": {
"name": "overridingEmploymentEndDate",
"in": "query",
"description": "The overriding employment end date",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2026-12-31"
}
},
"leaveTypeId": {
"name": "leaveTypeId",
"in": "path",
"description": "The unique identifier of the leave type",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"leaveRequestIds": {
"name": "leaveRequestIds",
"in": "query",
"description": "Comma separated list of leaveRequestIds (GUIDs) to get the currently available units for.\n",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab, d27acd0d-75d7-4fc8-8b22-4a3924585def"
}
},
"leaveId": {
"name": "leaveId",
"in": "path",
"description": "The unique identifier of the leave",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"startDate": {
"name": "startDate",
"in": "query",
"description": "The start date of the leave period",
"schema": {
"type": "string",
"pattern": "date",
"example": "2022-08-01"
}
},
"endDate": {
"name": "endDate",
"in": "query",
"description": "The end date of the leave period",
"schema": {
"type": "string",
"pattern": "date",
"example": "2022-08-07"
}
},
"referenceDate-2": {
"name": "referenceDate",
"in": "query",
"description": "Set a reference date for the following logic\n 1. To determine the active `function` and `department` of the employment\n 2. To calculate `usageAfterToday` and `usageThroughToday`\n 3. To determine the year for which the leave balance is returned\n\nIf not provided, \"today\" is used",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2020-12-31"
}
},
"leaveType": {
"name": "leaveType",
"in": "query",
"description": "Select which `leaveType` will be returned. Based on the provided 'leaveType.key'(s)\n\nIf not provided, the `leaveType` 16 (Verlof) is returned (16 is the sum of leaveType 1 (bovenwettelijk verlof) and 15 (wettelijk verlof))",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "integer",
"example": [
1,
15,
99
]
}
}
},
"payrollPeriodIdStart": {
"name": "payrollPeriodIdStart",
"in": "query",
"description": "The unique identifier of the first payroll period to return",
"example": 202004,
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"payrollPeriodIdEnd": {
"name": "payrollPeriodIdEnd",
"in": "query",
"description": "The unique identifier of the last payroll period to return",
"example": 202006,
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
"payrollrunId": {
"name": "payrollrunId",
"in": "path",
"description": "The unique identifier of the payroll run",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"sortOnField": {
"name": "sortOnField",
"in": "query",
"description": "Field on which the payslips will be sorted. By default the payslips are sorted by `employeeNumber`.\nPossible values for this parameter are:\n- employeeNumber: Sort payslips by employee number\n- name: Sort payslips by last name\n",
"required": false,
"schema": {
"type": "string",
"default": "employeeNumber",
"enum": [
"employeeNumber",
"lastName",
"firstName"
]
}
},
"includeEmploymentsWithMijnLoketAccess": {
"name": "includeEmploymentsWithMijnLoketAccess",
"in": "query",
"description": "Indicates whether to include employments for which the employee has access to Mijn Loket.\nPossible values for this parameter are:\n- true: Include employments with Mijn Loket access(All employments)\n- false: Exclude employments with Mijn Loket access\n",
"required": false,
"schema": {
"type": "boolean",
"default": true
}
},
"sepafileId": {
"name": "sepafileId",
"in": "path",
"required": true,
"description": "Sepa file ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
"paymentType": {
"name": "paymentType",
"in": "query",
"description": "Indicates the type of payment for the SEPA file.\nIn case salary is selected the following will be included in the SEPA xml file\n```\n \n SALA\n \n```",
"schema": {
"type": "string",
"default": "Salary",
"enum": [
"Other",
"Salary"
]
},
"x-loket-db-field": "dbo.ctSoortBetaling.Code"
},
"batchBooking": {
"name": "batchBooking",
"in": "query",
"description": "Determines whether the Batch Booking \\ 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.\n\nPossible values for this parameter are:\n- Exclude: Do not include \\ tag in SEPA file\n- IncludeTrue: Include \\ tag in SEPA file and set it to 'True'\n- IncludeFalse: Include \\ tag in SEPA file and set it to 'False'\n",
"schema": {
"type": "string",
"default": "BtchBookgExclude",
"enum": [
"BtchBookgExclude",
"BtchBookgTrue",
"BtchBookgFalse"
]
}
},
"requestedExecutionDate": {
"name": "requestedExecutionDate",
"in": "query",
"description": "This value is used when creating the (non) sepa file to set the value of \\",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
"paymentReason": {
"name": "paymentReason",
"in": "query",
"description": "Reason for the payment, eg Salary. Appears in the tag \\ if provided.",
"required": false,
"schema": {
"type": "string"
}
},
"startDateRequired": {
"name": "startDate",
"in": "query",
"description": "The start date",
"required": true,
"schema": {
"type": "string",
"pattern": "date",
"example": "2020-08-01"
}
},
"endDateRequired": {
"name": "endDate",
"in": "query",
"description": "The end date",
"required": true,
"schema": {
"type": "string",
"pattern": "date",
"example": "2020-08-31"
}
},
"payrollComponents": {
"name": "payrollComponents",
"in": "query",
"description": "Can be used to filter what payroll components are returned. Cannot be used in combination with payrollComponentSet.",
"required": false,
"schema": {
"type": "array",
"example": "70,151,12",
"items": {
"type": "integer",
"format": "int32"
}
}
},
"payrollComponentSet-2": {
"name": "payrollComponentSet",
"in": "query",
"description": "A predefined set of payroll components to filter what payroll components are returned",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
"payrollPeriodCompareId": {
"name": "payrollPeriodId",
"in": "query",
"description": "The unique identifier of the payroll period",
"example": 202001,
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"payrollPeriodIdStart-2": {
"name": "payrollPeriodIdStart",
"in": "query",
"description": "The unique identifier of the payroll period",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"payrollPeriodIdEnd-2": {
"name": "payrollPeriodIdEnd",
"in": "query",
"description": "The unique identifier of the payroll period",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"acceptAsync": {
"name": "Accept",
"in": "header",
"description": "The accept header is used to influence what type of output is returned and in most cases the version of the output\n\nThe output of the endpoint is provided async. The default option is `responseType=async;text/csv`. Two options are supported:\n * responseType=async;text/csv\n * responseType=async;application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
"required": true,
"schema": {
"type": "string",
"example": "responseType=async;text/csv"
}
},
"PayrollPeriodToCompare": {
"name": "payrollPeriodIdToCompare",
"in": "query",
"description": "The unique identifier of the base payroll period",
"example": 202503,
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"PayrollPeriodCompareTo": {
"name": "payrollPeriodIdCompareTo",
"in": "query",
"description": "The unique identifier of the payroll period to which the base payroll period is compared",
"example": 202502,
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"payrollComponentId-2": {
"name": "payrollComponentId",
"in": "query",
"description": "The component id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"includeTableAndOrTariff": {
"name": "tableTariff",
"in": "query",
"description": "Indicates whether the table and/or tariff values should be included in the response.",
"required": true,
"schema": {
"type": "string",
"enum": [
"table",
"tariff",
"tableAndTariff"
]
}
},
"includeFromDeviationPercentage": {
"name": "includeFromDeviationPercentage",
"in": "query",
"description": "Indicates from deviation percentage results should be included in the response. When set to 0, all results are included.",
"required": true,
"schema": {
"type": "number",
"format": "double",
"example": 3.14,
"minimum": 0
}
},
"sortOnField-2": {
"name": "sort",
"in": "query",
"description": "Indicates on which field the results should be sorted. Default is on the payroll component.",
"required": true,
"schema": {
"type": "string",
"enum": [
"employerName",
"administrationName",
"clientNumber",
"administrationNumber",
"percentageDifference"
]
}
},
"payrollComponentSetId-2": {
"name": "payrollComponentSetId",
"in": "query",
"description": "A predefined set of payroll components to filter what payroll components are returned",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
"acceptNoJson": {
"name": "Accept",
"in": "header",
"description": "The accept header is used to influence what type of output is returned and in most cases the version of the output\n\nThe default option is `text/csv;version=yyyy-MM-dd`. For the export functionality two other options are supported:\n * text/csv;version=yyyy-MM-dd\n * application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;version=yyyy-MM-dd",
"required": true,
"schema": {
"type": "string",
"example": "application/json;version=2018-01-01"
}
},
"version-2": {
"name": "version",
"in": "path",
"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.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"logoId": {
"name": "logoId",
"in": "path",
"description": "The unique identifier of a logo",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"providerId-2": {
"name": "providerId",
"in": "path",
"description": "The unique identifier of an provider",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"groupClassificationId": {
"name": "groupClassificationId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"year-3": {
"name": "year",
"in": "query",
"description": "The payroll year",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"maxLength": 4,
"example": 2018
}
},
"sortOnField-3": {
"name": "sort",
"in": "query",
"description": "Indicates on which field the results should be sorted.",
"required": true,
"schema": {
"type": "string",
"enum": [
"employerName",
"administrationName",
"clientNumber",
"administrationNumber",
"percentageUtilization"
]
}
},
"authorizationSetId": {
"name": "authorizationSetId",
"in": "path",
"description": "The unique identifier of an authorization set",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"moduleSetId": {
"name": "moduleSetId",
"in": "path",
"description": "The unique identifier of an module set",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"notificationSetId": {
"name": "notificationSetId",
"in": "path",
"description": "The unique identifier of an notification set",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"payrollPeriodIdPath": {
"name": "payrollPeriodId",
"in": "path",
"description": "The unique identifier of the payroll period to return.",
"example": 202201,
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"yearPath": {
"name": "year",
"in": "path",
"description": "The year.",
"example": 2024,
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"journalrunId": {
"name": "journalrunId",
"in": "path",
"description": "The unique identifier of the payroll run",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"consolidate": {
"name": "consolidate",
"in": "query",
"description": "Dictates how the output is consolidated",
"required": false,
"schema": {
"type": "string",
"enum": [
"BasedOnLedgerAccountConfiguration",
"Always",
"Never"
],
"default": "BasedOnLedgerAccountConfiguration"
}
},
"startPeriod-2": {
"name": "startPeriod",
"in": "query",
"description": "First period (=from) of the requested timebox. Use the format 'YYYYPP'",
"example": 201901,
"required": true,
"schema": {
"type": "integer"
}
},
"endPeriod-2": {
"name": "endPeriod",
"in": "query",
"description": "Last period (=up to and including) of the requested timebox. Use the following 'YYYYPP'",
"example": 201912,
"required": true,
"schema": {
"type": "integer"
}
},
"reportYear-2": {
"name": "reportYear",
"in": "query",
"description": "A valid year to be shown on the report.",
"example": "2018",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"reportPeriodNumber": {
"name": "reportPeriodNumber",
"in": "query",
"description": "A valid period number to be shown on the report.",
"example": "01",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"reportDate": {
"name": "reportDate",
"in": "query",
"description": "A valid booking date to be shown on the report.",
"example": "2018-01-01",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
"journalConfigurationId": {
"name": "journalConfigurationId",
"in": "path",
"description": "The unique identifier of a journal configuration",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"journalProfileId": {
"name": "journalProfileId",
"in": "path",
"description": "The unique identifier of a journal profile.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"journalProfileId-2": {
"name": "journalProfileId",
"in": "path",
"description": "The unique identifier of a journal profile",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"ledgerAccountId": {
"name": "ledgerAccountId",
"in": "path",
"description": "The unique identifier of a ledger account",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"ledgerAccountToPayrollComponentLinkId": {
"name": "ledgerAccountToPayrollComponentLinkId",
"in": "path",
"description": "The unique identifier of a ledger account to payroll component link",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"costCenterId": {
"name": "costCenterId",
"in": "path",
"description": "The unique identifier of a cost center",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"costUnitId": {
"name": "costUnitId",
"in": "path",
"description": "The unique identifier of a cost unit",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"journalAllocationId": {
"name": "journalAllocationId",
"in": "path",
"description": "The unique identifier of the journal allocation",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"authorizationGroupId": {
"name": "authorizationGroupId",
"in": "path",
"description": "The unique identifier of a authorization group",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"includeAddEmployerWizardInformation": {
"name": "includeAddEmployerWizardInformation",
"in": "query",
"description": "Include information about the add employer wizard. This is only relevant when the user is authorized to add employers. If this parameter is not supplied, the information will not be included.\n",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"example": true
}
},
"applicationId": {
"name": "applicationId",
"in": "path",
"description": "The unique identifier of an integration",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"applicationId-2": {
"name": "applicationId",
"in": "path",
"description": "The unique identifier of an application",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"connectedApplicationId": {
"name": "connectedApplicationId",
"in": "path",
"description": "The unique identifier of a connected application",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"transferNotificationsTo": {
"name": "transferNotificationsTo",
"in": "query",
"description": "The unique identifier of the user to transfer unread notifications to",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
"employerId-3": {
"name": "employerId",
"in": "path",
"description": "The unique identifier of an employer",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"userResponsibilityId": {
"name": "userResponsibilityId",
"in": "path",
"description": "The unique identifier of a user responsibility",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"userResponsibilityId-2": {
"name": "userResponsibilityId",
"in": "path",
"description": "The unique identifier of a user responsibilityId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"providerUserId": {
"name": "providerUserId",
"in": "path",
"description": "The unique identifier of a provider user",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"employerUserId": {
"name": "employerUserId",
"in": "path",
"description": "The unique identifier of a employer user",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"payrollPeriodId-4": {
"name": "payrollPeriodId",
"in": "path",
"description": "The unique identifier of an payroll period",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"includeEmployeeSelfServiceNotRequired": {
"name": "includeEmployeeSelfService",
"in": "query",
"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,
"required": false,
"schema": {
"type": "boolean"
}
},
"payrolltaxreturnId": {
"name": "payrolltaxreturnId",
"in": "path",
"description": "The unique identifier of the payroll tax return",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"messageReference": {
"name": "messageReference",
"in": "path",
"description": "The unique identifier of the payroll tax return",
"required": true,
"schema": {
"type": "string"
}
},
"payrollPeriodIdPath-2": {
"name": "payrollPeriodId",
"in": "path",
"description": "The unique identifier of the payroll period to return.",
"example": 202401,
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"postalCode": {
"name": "postalCode",
"in": "query",
"description": "A valid postal code",
"example": "5037AA",
"required": true,
"schema": {
"type": "string"
}
},
"houseNumber": {
"name": "houseNumber",
"in": "query",
"description": "A valid house number (without addition)",
"example": 1,
"required": true,
"schema": {
"type": "integer"
}
},
"query": {
"name": "query",
"in": "query",
"description": "A term by wich the address might be found the more detailed the better the search results",
"example": "Van Spaendonck Tilburg",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
},
"lat": {
"name": "lat",
"in": "query",
"description": "latitude for the bias in the search results. Results will be ordered in likelyhood to be relevant to the given latitude (and longitude)",
"example": 51.585996,
"required": false,
"schema": {
"type": "number",
"format": "double",
"minimum": -90,
"maximum": 90
}
},
"lon": {
"name": "lon",
"in": "query",
"description": "longitude for the bias in the search results. Results will be ordered in likelyhood to be relevant to the given longitude (and latitude)",
"example": 5.028622,
"required": false,
"schema": {
"type": "number",
"format": "double",
"minimum": -180,
"maximum": 180
}
},
"top": {
"name": "top",
"in": "query",
"description": "the top x number of results that are returned. If not supplied 5 results are returned",
"example": 10,
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 100
}
},
"query-2": {
"name": "query",
"in": "query",
"description": "The route as defined by the geo-coördinates.\n\nUse the following formatting -> latitude,longitude;latitude,longitude;latitude,longitude etc\n\nAtleast 2 sets of geo-coördinates have to be provided in order for a route to be calculated\n\nPlease note: latitude must be a value between -90 and 90 where as longitude must be a value between -180 and 180",
"example": "51.585996,5.028622;51.555833,5.09073;51.585996,5.028622",
"required": true,
"schema": {
"type": "string"
}
},
"routeType": {
"name": "routeType",
"in": "query",
"description": "The method of how the route is calculated. This can influence the distance to travel.\n\nIntegers can be used instead of the strings\n1 --> fastest / snelste 2 --> shortest / kortste",
"example": "Fastest",
"required": true,
"schema": {
"type": "string",
"enum": [
"fastest",
"shortest"
]
}
},
"dateOfBirth": {
"name": "dateOfBirth",
"in": "query",
"description": "The date of birth of the employee",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
"chamberOfCommerceNumber": {
"name": "chamberOfCommerceNumber",
"in": "path",
"description": "The unique identifier of the kvk (8 numbers)",
"required": true,
"schema": {
"type": "string"
}
},
"startDate-2": {
"name": "startDate",
"in": "query",
"description": "A valid date (yyyy-MM-dd). First day of the timebox for which calendar data will be collected.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
"endDate-2": {
"name": "endDate",
"in": "query",
"description": "A valid date (yyyy-MM-dd). Last day of the timebox for which calendar data will be collected.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
"employmenttemplateId": {
"name": "employmenttemplateId",
"in": "path",
"description": "The unique identifier of the concept employee",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"declarationIds": {
"name": "declarationIds",
"in": "query",
"description": "DeclarationIds for which the attachment is available. This parameter may be included multiple times to indicate multiple declarationIds.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"payrollPeriodId-5": {
"name": "payrollPeriodId",
"in": "path",
"description": "The unique identifier of the payroll period",
"example": "202103",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
"documentId": {
"name": "documentId",
"in": "path",
"description": "The unique identifier of the employment dossier document",
"required": true,
"schema": {
"type": "string"
}
},
"documentId-2": {
"name": "documentId",
"in": "path",
"description": "The unique identifier of the employer dossier document",
"required": true,
"schema": {
"type": "string"
}
},
"documentId-3": {
"name": "documentId",
"in": "path",
"description": "The unique identifier of the document template",
"required": true,
"schema": {
"type": "string"
}
},
"documentId-4": {
"name": "documentId",
"in": "path",
"description": "The unique identifier of the template",
"example": "P123456789",
"required": true,
"schema": {
"type": "string"
}
},
"startDate-3": {
"name": "startDate",
"in": "query",
"description": "The report will include document signatures which were started on or after the startdate",
"example": "2023-01-01",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
"endDate-3": {
"name": "endDate",
"in": "query",
"description": "The report will include document signatures which were started on or before the enddate",
"example": "2023-01-01",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
"apgPensionDeclarationId": {
"name": "apgPensionDeclarationId",
"in": "path",
"description": "The unique identifier of the payroll tax return",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"externalPartyKey": {
"name": "externalPartyKey",
"in": "path",
"description": "The external party key is used to filter the collection on a specific external party key.",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"maxLength": 4,
"example": 2018
}
},
"upaPensionDeclarationId": {
"name": "upaPensionDeclarationId",
"in": "path",
"description": "The unique identifier of the pension declaration.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"externalPartyIdentificationId": {
"name": "externalPartyIdentificationId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"referenceDate-3": {
"name": "referenceDate",
"in": "query",
"description": "Set a reference date for choosing the date dependent data.\n\nIf not set the system date is used.",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2022-01-01"
}
},
"process": {
"name": "process",
"in": "query",
"description": "Indicates what action is to be performed so the right set if payroll runs can be returned",
"required": true,
"schema": {
"type": "string",
"enum": [
"Delete",
"Initiate"
]
}
},
"referenceDateRequired-2": {
"name": "referenceDate",
"in": "query",
"description": "Set a reference date for choosing the date dependent data.\n\nIf not set the system date is used.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2022-01-01"
}
},
"downloadRequestId": {
"name": "downloadRequestId",
"in": "path",
"description": "The unique identifier of the downloadRequest",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"noteId": {
"name": "noteId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"emailTemplateId": {
"name": "emailTemplateId",
"in": "path",
"description": "The unique identifier of the email template record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"eventTypeId": {
"name": "eventTypeId",
"in": "path",
"description": "The unique identifier of the record",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"payrollPeriodId-6": {
"name": "payrollPeriodId",
"in": "query",
"description": "The unique identifier of the payroll period",
"example": 202308,
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
"applicationSetId": {
"name": "applicationSetId",
"in": "path",
"description": "The unique identifier of the Applicationset",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"emailIdentityId": {
"name": "emailIdentityId",
"in": "path",
"description": "The emailIdentity.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"year-4": {
"name": "year",
"in": "query",
"description": "The year of the period the data will be imported in.",
"example": 2023,
"required": true,
"schema": {
"type": "integer"
}
},
"period-2": {
"name": "period",
"in": "query",
"description": "The period the data will be imported in.",
"example": 12,
"required": true,
"schema": {
"type": "integer"
}
},
"payslipType-2": {
"name": "payslipType",
"in": "query",
"description": "The paysliptype to import the data in.",
"example": 1,
"required": true,
"schema": {
"type": "integer"
}
},
"workRelatedCostsSchemeFinancialId": {
"name": "workRelatedCostsSchemeFinancialId",
"in": "path",
"description": "The unique identifier of a work related costs scheme",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"payrollComponentSet-3": {
"name": "payrollComponentSet",
"in": "query",
"description": "The given payroll component set will influence the payroll components included in the output",
"example": "33023442-67cd-4260-9355-d65289df0a9f",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
"modules": {
"name": "modules",
"in": "query",
"description": "Allows the user to filter the modules.\n\nIf the option \"All\" is selected, all modules are returned.\nIf \"None\" is selected, no modules are returned. \nIf \"Selection\" is selected, only the modules that are supplied in the `moduleIds` querystring parameter are returnd.\nIf \"OnlyEnabled\" is selected, only the modules that are enabled for the employer are returned.\n",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"All",
"None",
"Selection",
"OnlyEnabled"
]
},
"example": "All",
"readOnly": false
}
},
"moduleIds": {
"name": "moduleIds",
"in": "query",
"description": "A comma separated list of module ids to filter the modules on. This parameter is only used when the `module` querystring parameter is set to \"Selection\".\n",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$"
},
"example": [
"b14acd0d-75d7-4fc8-8b22-4a3924585cab"
]
}
},
"reportYear-3": {
"name": "reportYear",
"in": "query",
"description": "A valid year for which the information is requested.",
"example": 2025,
"required": true,
"schema": {
"type": "integer"
}
},
"testYear": {
"name": "testYear",
"in": "query",
"description": "If set to true, only payroll periods that are part of a test year are included in the result. If set to false, only payroll periods not part of a test year are included in the result.",
"required": false,
"schema": {
"type": "boolean",
"example": true
}
},
"payrollTaxReturnId": {
"name": "payrollTaxReturnId",
"in": "path",
"description": "The unique identifier of the payroll tax return",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
},
"schemas": {
"totalSize": {
"type": "integer",
"description": "Total number of records, taking into account the given filter.",
"example": 650
},
"pageSize": {
"type": "integer",
"description": "Number of records in the response",
"example": 250
},
"totalPages": {
"type": "integer",
"description": "Number of pages available",
"example": 3
},
"currentPage": {
"type": "integer",
"description": "Current page returned in the response",
"example": 2
},
"paging": {
"type": "object",
"description": "data to be used for paging",
"properties": {
"totalSize": {
"$ref": "#/components/schemas/totalSize"
},
"pageSize": {
"$ref": "#/components/schemas/pageSize"
},
"totalPages": {
"$ref": "#/components/schemas/totalPages"
},
"currentPage": {
"$ref": "#/components/schemas/currentPage"
}
}
},
"version": {
"type": "object",
"properties": {
"obsoleteDate": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The date (can be null) on which the `resourceVersion` is no longer supported/available"
},
"resourceVersion": {
"type": "string",
"format": "date",
"description": "The resource version of the object in the response",
"example": "2018-12-31"
}
}
},
"version-2": {
"type": "object",
"description": "The version of the resource",
"properties": {
"version": {
"$ref": "#/components/schemas/version"
}
}
},
"messageWarning": {
"type": "array",
"items": {
"properties": {
"type": {
"type": "string",
"example": "Warning",
"description": "Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)"
},
"description": {
"type": "string",
"example": "",
"description": "Describes the message"
},
"id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity ",
"example": "904d6856-6034-4624-bcbc-886188c115c5"
},
"code": {
"type": "integer",
"format": "int32",
"description": "Identifying code for the message",
"example": 12
},
"properties": {
"type": "array",
"minimum": 0,
"description": "An array that can contain additional information",
"items": {
"type": "string"
}
}
}
}
},
"messageWarning-2": {
"type": "object",
"description": "a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.",
"minimum": 0,
"properties": {
"messages": {
"$ref": "#/components/schemas/messageWarning"
}
}
},
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"causeOfAbsence": {
"type": "object",
"format": "metadata",
"description": "The cause of the absence. This endpoint is intended for the registration of two types of absence:\n\n 1) Illness/sickness\n\n 2) \"Vangnet\" such as maternity leave, organ donation or adoption leave\n\n\nOther absences such as Vacation days, unpayed leave and Personal leave are registerd using the leave endpoint\n",
"x-loket-implementation": "Indien de waarde 0 is op NULL zetten. Dit moet nog onderzocht worden in de productie database. Via de interface is de waarde 0 onbekend niet toegestaan maar ik weet niet of er regels bestaan in de database waar de waarde toch op 0 staat.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the cause of the absence. Possible values can be acquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.RedenZiek"
},
"value": {
"type": "string",
"example": "maternity leave",
"description": "Description of the cause of the absence.",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctRedenZiek.Omschrijving"
}
}
},
"hoursWorkedOnFirstDayOfAbsence": {
"type": [
"integer",
"null"
],
"example": 3,
"description": "The number of hours worked on the first day of the absence.",
"minimum": 1,
"maximum": 8,
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.AantalUrenGewerktEersteZiektedag",
"x-loket-implementation": "Indien de waarde 0 is op NULL zetten"
},
"actionToBeTakenByOccupationalHealthAndSafetyService": {
"type": "object",
"format": "metadata",
"description": "The desired action to be taken regarding the absence by the occupational health and safety service (arbodienst).\n",
"x-loket-implementation": "Indien de waarde 0 is op NULL zetten",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.GewensteControleArbodienst"
},
"value": {
"type": "string",
"example": "Spoedcontrole aan huis",
"description": "Description of the desired action to be taken by the occupational health and safety service.",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctGewensteControleArbodienst.Omschrijving"
}
}
},
"expectedDuration": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The expected duration of the absence. If the expected duration is unknown, this field will be NULL.",
"x-loket-implementation": "Het idee is om het veld \"hersteld binnen twee weken\" weg te halen. Indien de waarde 0 is dient dit veld NULL te zijn.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the expected duration of the absence. Possible values can be acquired via the metadata endpoint.",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.GeschatteDuur"
},
"value": {
"type": "string",
"example": "Minder dan 1 week",
"description": "Description of the expected duration of the absence.",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctGeschatteDuur.Omschrijving"
}
}
},
"isDisruptedEmploymentRelationship": {
"type": "boolean",
"example": true,
"description": "Indicates whether the employement relationship between employee and employer is disrupted.",
"readOnly": false,
"x-loket-implementation": "De verbijzondering reden ziek bevat eigenlijk alleen nog de waarde verstoorde arbeidsverhouding. Ik wil dat veld dan ook omzetten in deze boolean. Andere reden ziek mogen wij om privacy redenen niet meer vastleggen. Indien Loket.Ziekmelding.VerbijzonderingRedenziek = 13 dan True in alle andere gevallen False.",
"x-loket-db-field": "Loket.Ziekmelding.VerbijzonderingRedenZiek"
},
"isThirdPartyLiability": {
"type": [
"boolean",
"null"
],
"example": false,
"readOnly": false,
"description": "This field is related to `accidentType`. \nWhen `accidentType` is specified, this field indicates whether a third party is liable for the accident.",
"x-loket-db-field": "Loket.Ziekmelding.Verhaalbaar",
"x-loket-implementation": "Niet zeker of ik hier een boolean van kan maken. In de code tabel zit ook een n.v.t. maar of nvt ook false is weet ik niet. Daarom is het vooralsnog een nullable boolean."
},
"accidentType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The type of accident that led to the absence. This field will be NULL if the absence is not related to an accident.",
"x-loket-implementation": "Indien n.v.t. (waarde = 0) het veld op NULL zetten",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the accident type. Possible values can be aquired via the metadata endpoint.",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.SpecificatieOngeval"
},
"value": {
"type": "string",
"example": "work related accident",
"description": "Description of the accident type.",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSpecificatieOngeval.Omschrijving"
}
}
},
"isWorkRelatedIllness": {
"type": "boolean",
"example": false,
"description": "Beroepsziekte",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.Beroepsziekte"
},
"expectedDateOfChildbirth": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-01-21",
"description": "Bevallingsdatum",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.VermoedelijkeBevallingsdatum"
},
"expectedEndDateOfMaternityLeave": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-04-21",
"description": "verwachte datum einde zwangerschapsverlof",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.VermoedelijkeEinddatumBevallingsverlof"
},
"hasMobilityIssue": {
"type": [
"boolean",
"null"
],
"example": false,
"readOnly": false,
"description": "This field indicates whether the Employee has an issue limiting its mobility.",
"x-loket-db-field": "Loket.Ziekmelding.Mobiliteitsprobleem"
},
"isRecoveredWithinTwoWeeks": {
"type": "boolean",
"example": false,
"readOnly": false,
"description": "This field indicates whether the Employee is (expected) recoverd within two weeks, relating to a full recovery.",
"x-loket-db-field": "Loket.Ziekmelding.HerstelBinnenTweeWeken"
},
"comments": {
"type": [
"string",
"null"
],
"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,
"readOnly": false
},
"isHospitalised": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Betreft het een ziekenhuisopnamen",
"readOnly": false,
"x-loket-db-field": "loket.ziekmelding.Ziekenhuisopname",
"x-loket-implementation": "Indien onbekend (waarde = 0) het veld op NULL zetten"
},
"contactInformation": {
"type": [
"object",
"null"
],
"required": [
"startDate",
"country",
"street",
"city",
"postalCode",
"houseNumber"
],
"properties": {
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-21",
"description": "start date of the contact information",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.DatumIngangVerpleegAdres"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"description": "end date of the contact information",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.DatumEindeVerpleegAdres"
},
"locationType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "soort verpleegadres",
"x-loket-db-field": "loket.ziekmelding.VerpleegadresSoort",
"x-loket-implementation": "Indien n.v.t. (waarde = 0) het veld op NULL zetten. (ik ga er vanuit dat onbekend in de code tabel niet de waarde 0 heeft omdat n.v.t. ook bestaat)",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the location type. Possible values can be aquired via the metadata endpoint",
"readOnly": false
},
"value": {
"type": "string",
"example": "Hospital",
"description": "Description of location type",
"maxLength": 50,
"readOnly": true
}
}
},
"name": {
"type": [
"string",
"null"
],
"example": "RadboudUMC Nijmegen",
"description": "name of the institute for the contact information.",
"minLength": 1,
"maxLength": 70,
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.VerpleegadresNaam"
},
"street": {
"type": "string",
"example": "Voordijk",
"description": "Streetname of the address",
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.StraatnaamAfwijkend"
},
"city": {
"type": "string",
"example": "Leiden",
"maxLength": 24,
"description": "City of the address",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.PlaatsnaamAfwijkend"
},
"houseNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"description": "House number of the address",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.HuisnummerAfwijkend"
},
"houseNumberAddition": {
"type": [
"string",
"null"
],
"example": "D",
"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.",
"maxLength": 4,
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.HuisnummertoevoegingAfwijkend"
},
"furtherIndication": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the further indication. Possible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.NadereAanduidingAfwijkend"
},
"value": {
"type": "string",
"example": "WW",
"description": "The description of the further indication, the possible values are \"WW\" and \"AB\"",
"readOnly": true,
"x-loket-db-field": "dbo.ctNadereAanduiding.Omschrijving"
}
}
},
"postalCode": {
"type": "string",
"example": "1234 AA",
"description": "The postal code of the address",
"maxLength": 9,
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.PostcodeAfwijkend"
},
"country": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the country. Possible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.LandAfwijkend"
},
"value": {
"type": "string",
"example": "Netherlands",
"description": "The name of the country",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.Omschrijving"
},
"isoCode": {
"type": "string",
"example": "NL",
"description": "The ISO 3166-1 alpha-2 value for the country",
"maxLength": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.IsoCode"
}
}
},
"phoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 13-1234567",
"description": "The phone number to contact the employee on.",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.VerpleegadresTelefoon"
}
}
},
"caseManager": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"type": "string",
"example": "Ben Hur",
"description": "Name of the case manager for reintegration.",
"readOnly": false,
"maxLength": 25,
"x-loket-db-field": "Loket.Ziekmelding.CaseManagerNaam"
},
"function": {
"type": [
"string",
"null"
],
"example": "Ben Hur",
"description": "Function of the case manager.",
"readOnly": false,
"maxLength": 50,
"x-loket-db-field": "Loket.Ziekmelding.CaseManagerFunctie"
},
"organization": {
"type": [
"string",
"null"
],
"example": "Ben Hur",
"description": "Function of the case manager.",
"readOnly": false,
"maxLength": 70,
"x-loket-db-field": "Loket.Ziekmelding.CaseManagerOrganisatie"
},
"phoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 13-1234567",
"description": "The phone number of the employee.",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.CaseManagerTelefoon"
}
}
},
"reintegration": {
"type": [
"object",
"null"
],
"properties": {
"reintegrationGoal": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the reintegration goal. Related to the Wet Verbetering Poortwachter.",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.DoelIntegratie"
},
"value": {
"type": "string",
"example": "Werkhervatting in de eigen functie",
"description": "The name of the country",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctDoelReintegratie"
}
}
},
"dateOfFinalizingPlanOfAction": {
"type": "string",
"format": "date",
"description": "The day on which a plan of action (for return to normal work) was finalized.\n",
"readOnly": false,
"x-loket-db-field": "loket.ziekmelding.DatumPlanVanAanpak"
}
}
},
"absencePutGetObject": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"causeOfAbsence": {
"$ref": "#/components/schemas/causeOfAbsence"
},
"hoursWorkedOnFirstDayOfAbsence": {
"$ref": "#/components/schemas/hoursWorkedOnFirstDayOfAbsence"
},
"actionToBeTakenByOccupationalHealthAndSafetyService": {
"$ref": "#/components/schemas/actionToBeTakenByOccupationalHealthAndSafetyService"
},
"expectedDuration": {
"$ref": "#/components/schemas/expectedDuration"
},
"isDisruptedEmploymentRelationship": {
"$ref": "#/components/schemas/isDisruptedEmploymentRelationship"
},
"isThirdPartyLiability": {
"$ref": "#/components/schemas/isThirdPartyLiability"
},
"accidentType": {
"$ref": "#/components/schemas/accidentType"
},
"isWorkRelatedIllness": {
"$ref": "#/components/schemas/isWorkRelatedIllness"
},
"expectedDateOfChildbirth": {
"$ref": "#/components/schemas/expectedDateOfChildbirth"
},
"expectedEndDateOfMaternityLeave": {
"$ref": "#/components/schemas/expectedEndDateOfMaternityLeave"
},
"hasMobilityIssue": {
"$ref": "#/components/schemas/hasMobilityIssue"
},
"isRecoveredWithinTwoWeeks": {
"$ref": "#/components/schemas/isRecoveredWithinTwoWeeks"
},
"comments": {
"$ref": "#/components/schemas/comments"
},
"isHospitalised": {
"$ref": "#/components/schemas/isHospitalised"
},
"contactInformation": {
"$ref": "#/components/schemas/contactInformation"
},
"caseManager": {
"$ref": "#/components/schemas/caseManager"
},
"reintegration": {
"$ref": "#/components/schemas/reintegration"
},
"progress": {
"type": "object",
"readOnly": true,
"properties": {
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-21",
"description": "start dat of the incapacityPercentage",
"readOnly": true,
"x-loket-db-field": "Loket.Ziekteverloop.DatumIngang"
},
"endOfAbsence": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"description": "date and reason for the closing/end of the absence",
"properties": {
"date": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The last day of the absence.\n",
"readOnly": true,
"x-loket-db-field": "loket.ziekmelding.DatumHersteld"
},
"reason": {
"type": "object",
"format": "metadata",
"description": "redenhersteld",
"x-loket-implementation": "Indien onbekend (waarde = 0) het veld op NULL zetten",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the reason why the absence is ended. Possible values can be aquired via the metadata endpoint.",
"readOnly": true,
"x-loket-db-field": "Loket.Ziekmelding.RedenHersteld"
},
"value": {
"type": "string",
"example": "Fully recoverd",
"description": "Description of the reason why the absence ended.",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctRedenHersteld.Omschrijving"
}
}
}
}
},
"currentIncapacityPercentage": {
"type": "integer",
"example": 100,
"minimum": 1,
"maximum": 100,
"description": "percentage of not being able to work",
"readOnly": true,
"x-loket-db-field": "Loket.Ziekteverloop.PercentageArbeidsongeschikt"
}
}
}
}
},
"messageBrokenBusinessRule": {
"type": "array",
"items": {
"properties": {
"type": {
"type": "string",
"example": "BrokenBusinessRule",
"description": "Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)"
},
"description": {
"type": "string",
"example": "Invalid value for ",
"description": "Describes the message"
},
"id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity",
"example": "904d6856-6034-4624-bcbc-886188c115c5"
},
"code": {
"type": "integer",
"format": "int32",
"description": "Identifying code for the message",
"example": 12
},
"properties": {
"type": "array",
"minimum": 0,
"description": "An array that can contain additional information",
"items": {
"type": "string"
}
}
}
}
},
"messageBrokenBusinessRule-2": {
"type": "object",
"description": "a broken business rule indacateds that the given payload is not valide",
"minimum": 0,
"properties": {
"messages": {
"$ref": "#/components/schemas/messageBrokenBusinessRule"
}
}
},
"absencePostObject": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"causeOfAbsence": {
"$ref": "#/components/schemas/causeOfAbsence"
},
"hoursWorkedOnFirstDayOfAbsence": {
"$ref": "#/components/schemas/hoursWorkedOnFirstDayOfAbsence"
},
"actionToBeTakenByOccupationalHealthAndSafetyService": {
"$ref": "#/components/schemas/actionToBeTakenByOccupationalHealthAndSafetyService"
},
"expectedDuration": {
"$ref": "#/components/schemas/expectedDuration"
},
"isDisruptedEmploymentRelationship": {
"$ref": "#/components/schemas/isDisruptedEmploymentRelationship"
},
"isThirdPartyLiability": {
"$ref": "#/components/schemas/isThirdPartyLiability"
},
"accidentType": {
"$ref": "#/components/schemas/accidentType"
},
"isWorkRelatedIllness": {
"$ref": "#/components/schemas/isWorkRelatedIllness"
},
"expectedDateOfChildbirth": {
"$ref": "#/components/schemas/expectedDateOfChildbirth"
},
"expectedEndDateOfMaternityLeave": {
"$ref": "#/components/schemas/expectedEndDateOfMaternityLeave"
},
"hasMobilityIssue": {
"$ref": "#/components/schemas/hasMobilityIssue"
},
"isRecoveredWithinTwoWeeks": {
"$ref": "#/components/schemas/isRecoveredWithinTwoWeeks"
},
"comments": {
"$ref": "#/components/schemas/comments"
},
"isHospitalised": {
"$ref": "#/components/schemas/isHospitalised"
},
"contactInformation": {
"$ref": "#/components/schemas/contactInformation"
},
"caseManager": {
"$ref": "#/components/schemas/caseManager"
},
"reintegration": {
"$ref": "#/components/schemas/reintegration"
},
"progress": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-21",
"description": "start dat of the incapacityPercentage",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekteverloop.DatumIngang"
},
"currentIncapacityPercentage": {
"type": "integer",
"example": 100,
"minimum": 1,
"maximum": 100,
"description": "percentage of not being able to work",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekteverloop.PercentageArbeidsongeschikt"
}
}
}
}
},
"endOfAbsenceObject": {
"properties": {
"endOfAbsence": {
"type": "object",
"format": "metadata",
"readOnly": false,
"description": "date and reason for the closing/end of the absence",
"properties": {
"date": {
"type": "string",
"format": "date",
"description": "The last day of the absence. Could also be the last day of employment if employment was to be ended.\n",
"readOnly": false,
"x-loket-db-field": "loket.ziekmelding.DatumHersteld"
},
"reason": {
"type": "object",
"format": "metadata",
"description": "redenhersteld",
"x-loket-implementation": "Indien onbekend (waarde = 0) het veld op NULL zetten",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the reason why the absence is ended. Possible values can be aquired via the metadata endpoint.",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekmelding.RedenHersteld"
},
"value": {
"type": "string",
"example": "Fully recoverd",
"description": "Description of the reason why the absence ended.",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctRedenHersteld.Omschrijving"
}
}
}
}
}
}
},
"absenceProgressObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-21",
"description": "start dat of the incapacityPercentage",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekteverloop.DatumIngang"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The last day that the `incapacityPercentage` is active.
\n",
"readOnly": true,
"x-loket-db-field": "Loket.Ziekteverloop.DatumEinde",
"x-loket-implementation": "Omdat er een \"fout\" zit in de huidige logica voor het vullen van de einddatum van het laatste verloop van de ziekmelding (tot datum in een t/m datum stoppen) moet voor het laatste verloop de datum door de interne service bepaald worden ipv de waarde uit de database over te nemen. Mogelijk kun je alle datum berekenen ipv alleen de laaste."
},
"incapacityPercentage": {
"type": "integer",
"example": 100,
"minimum": 1,
"maximum": 100,
"description": "percentage of not being able to work",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekteverloop.PercentageArbeidsongeschikt"
},
"typeOfWorkResumption": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The type of work the work the employee is fulfilling when partly returning to work.",
"x-loket-implementation": "In het geval dat SoortWerkhervatting 0 is, dit veld NULL maken",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The key of the type of work resumption. Possible values can be acquired via the metadata endpoint.\n",
"readOnly": false,
"x-loket-db-field": "Loket.Ziekteverloop.SoortWerkhervatting"
},
"value": {
"type": "string",
"example": "Eigen werk met aanpassing",
"description": "Description of the type of work resumption.\n",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctWerkhervatting"
}
}
},
"comments": {
"type": [
"string",
"null"
],
"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,
"readOnly": false
}
}
},
"contactHistory": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"contactDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which the contact was initiated.",
"readOnly": false
},
"contactMethod": {
"type": "object",
"format": "metadata",
"description": "The method of contacting the person\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the method of contacting the employee",
"readOnly": false
},
"value": {
"type": "string",
"example": "e-mail",
"description": "Description of the method of contact.",
"maxLength": 50,
"readOnly": true
}
}
},
"summary": {
"type": [
"string",
"null"
],
"description": "Summary of the contact.\n",
"minLength": 1,
"maxLength": 4000,
"readOnly": false
}
}
},
"absenceStatisticsDataObject": {
"type": "object",
"properties": {
"clientNumber": {
"type": "integer",
"format": "int32",
"example": 1234
},
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 14
},
"incomeRelationshipNumber": {
"type": "integer",
"format": "int32",
"example": 1
},
"formattedName": {
"type": "string",
"example": "Bos B"
},
"year": {
"type": "integer",
"format": "int32",
"example": 2024
},
"month": {
"type": "integer",
"format": "int32",
"example": 2024
},
"department": {
"type": [
"string",
"null"
],
"example": "Procurement",
"description": "The discription of the department of the employment."
},
"function": {
"type": [
"string",
"null"
],
"example": "Manager",
"description": "The discription of the function of the employment."
},
"percentageWeightedAbsenteeism": {
"type": "number",
"format": "double",
"example": 2400
},
"percentageWeightedAbsenteeismShort": {
"type": "number",
"format": "double",
"example": 2400
},
"percentageWeightedAbsenteeismMedium": {
"type": "number",
"format": "double",
"example": 2400
},
"percentageWeightedAbsenteeismLong": {
"type": "number",
"format": "double",
"example": 2400
}
}
},
"administration": {
"type": "object",
"x-loket-implementation": "Bij het teruggeven van administrations dient gelet te worden op de sortering die gebruikt wordt in Loket.prcVerloningList. Hier wordt gesorteerd op Loket.Verloning.DatumIngang en Loket.Verloning.DatumEinde. Deze sortering willen we voor nu hanteren. Mocht dit later niet handig blijken kunnen we beslissen om deze datumvelden in de API op te nemen en de front-end te laten sorteren naar wens. Hier is nu niet voor gekozen omdat deze twee datumvelden buiten de sortering geen betekenis hebben.",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"clientNumber": {
"type": "integer",
"format": "int32",
"example": 1234,
"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.",
"readOnly": true
},
"wageTaxNumber": {
"type": "string",
"maxLength": 12,
"example": "111111110L00",
"description": "The wage tax 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.",
"readOnly": true
},
"description": {
"type": "string",
"example": "Bakker",
"description": "Description of the administration",
"maxLength": 50,
"readOnly": false
},
"startDate": {
"type": "string",
"format": "date",
"example": "2016-01-01",
"description": "The first day the administration is active.\n",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2020-12-31",
"description": "The last day the administration is active.\n",
"readOnly": false
},
"isPayrollAdministration": {
"type": "boolean",
"example": true,
"description": "Indicates whether the administration is a payroll administration\n",
"readOnly": true
},
"employerId": {
"$ref": "#/components/schemas/id"
}
}
},
"name": {
"type": "string",
"example": "ABC administration",
"description": "Name of the administration",
"minLength": 1,
"maxLength": 70,
"readOnly": false,
"x-loket-db-field": "Ulsa.Werkgever.Naam"
},
"shortName": {
"type": [
"string",
"null"
],
"example": "ABC adm",
"description": "Shortened name of the administration",
"minLength": 1,
"maxLength": 12,
"readOnly": false,
"x-loket-db-field": "Ulsa.Werkgever.KorteNaam"
},
"administrationNumber": {
"type": [
"string",
"null"
],
"example": "ABC",
"description": "The administration number is a free field commonly used to register the debtors number.",
"minLength": 1,
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Ulsa.Werkgever.Administratienummer"
},
"clientNumber": {
"type": "integer",
"format": "int32",
"example": 1234,
"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.",
"readOnly": true,
"x-loket-db-field": "Ulsa.Werkgever.ClientNummer & Loket.Verloning.ClientNr",
"x-loket-implementation": "Het clientnummer is de verbinding tussen Ulsa.Werkgever en Loket.Verloning. Een waarde 0 in de database wordt als NULL teruggegeven in de API."
},
"description": {
"type": "string",
"example": "Bakker",
"description": "Description of the administration",
"minLength": 1,
"maxLength": 50,
"readOnly": false,
"x-loket-db-field": "Loket.Verloning.Omschrijving"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2016-01-01",
"description": "The first day the payroll administration is active.\n",
"readOnly": true,
"x-loket-db-field": "Loket.Verloning.DatumIngang"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2020-12-31",
"description": "The last day the payroll administration is active.\n",
"readOnly": false,
"x-loket-db-field": "Loket.Verloning.DatumEinde"
},
"cao": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "The CAO (CLA -> collective labor agrement) of the \"loonmodel\" the payroll administration is linked to.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 184,
"readOnly": true,
"x-loket-db-field": "Ulsa.Werkgever.Cao"
},
"value": {
"type": "string",
"example": "Agriculture",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctCAO.Omschrijving"
}
}
},
"loonmodel": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "The \"loonmodel\" (this is a Loket term) the payroll administration inherits the payrolling configuration from. Deviating from the loonmodel configuration on payrol administration level is possible.\n\n`loonmodel` is a metadata field within the provider context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 184,
"readOnly": true
},
"value": {
"type": "string",
"example": "Foresting monthly payrolling",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "ulsa.modelwerkgever.naam"
}
}
},
"groupClassification": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The group classification for the payroll administration. This field is used for filtering and grouping within the interface.\n\n`groupClassification` is a metadata field within the provider context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false,
"x-loket-db-field": "Ulsa.Werkgever.CollectiefGroepID"
},
"value": {
"type": "string",
"example": "South",
"readOnly": true,
"x-loket-db-field": "Ulsa.CollectiefGroep.Omschrijving"
}
}
},
"groupCode": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "Number (integer) used for grouping administrations.",
"example": 40,
"readOnly": false,
"x-loket-db-field": "Ulsa.Werkgever.Groepcode",
"x-loket-implementation": "Groepcode is een none nullable int. 0 = NULL"
},
"address": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "Voordijk",
"description": "Streetname of the address",
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "Straatnaam"
},
"city": {
"type": "string",
"example": "Leiden",
"maxLength": 24,
"description": "City of the address",
"readOnly": false,
"x-loket-db-field": "Plaatsnaam"
},
"houseNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"description": "House number of the address",
"readOnly": false,
"x-loket-db-field": "Huisnummer"
},
"houseNumberAddition": {
"type": [
"string",
"null"
],
"example": "D",
"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.",
"maxLength": 4,
"readOnly": false,
"x-loket-db-field": "Huisnummertoevoeging"
},
"furtherIndication": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the further indication. Possible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "NadereAanduiding"
},
"value": {
"type": "string",
"example": "WW",
"description": "The description of the further indication, the possible values are \"WW\" and \"AB\"",
"readOnly": true,
"x-loket-db-field": "dbo.ctNadereAanduiding.Omschrijving"
}
}
},
"postalCode": {
"type": "string",
"example": "1234AA",
"description": "The postal code of the address",
"maxLength": 9,
"readOnly": false,
"x-loket-db-field": "Postcode"
},
"location": {
"type": [
"string",
"null"
],
"example": "Fourth floor or building C",
"description": "The location like to further specify the address ",
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "Locatie"
},
"country": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the country. Possible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "Land"
},
"value": {
"type": "string",
"example": "Netherlands",
"description": "The name of the country",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.Omschrijving"
},
"isoCode": {
"type": "string",
"example": "NL",
"description": "The ISO 3166-1 alpha-2 value for the country",
"maxLength": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.IsoCode"
}
}
},
"province": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "A Dutch province",
"properties": {
"key": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"description": "The key for the province. Possible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "Provincie"
},
"value": {
"type": [
"string",
"null"
],
"example": "Noord-Holland",
"description": "The name of the province. Only the Dutch provices are supported and not translated",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctProvincie.Omschrijving"
}
}
}
}
},
"deviatingPostalAddress": {
"type": [
"object",
"null"
],
"properties": {
"street": {
"type": [
"string",
"null"
],
"example": "Voordijk",
"description": "Streetname of the address",
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "StraatnaamAfwijkend"
},
"city": {
"type": "string",
"example": "Leiden",
"maxLength": 24,
"description": "City of the address",
"readOnly": false,
"x-loket-db-field": "PlaatsnaamAfwijkend"
},
"houseNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 12,
"description": "House number of the address",
"readOnly": false,
"x-loket-db-field": "HuisnummerAfwijkend"
},
"houseNumberAddition": {
"type": [
"string",
"null"
],
"example": "D",
"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.",
"maxLength": 4,
"readOnly": false,
"x-loket-db-field": "HuisnummertoevoegingAfwijkend"
},
"furtherIndication": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the further indication. Possible values can be aquired by the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "NadereAanduidingAfwijkend"
},
"value": {
"type": "string",
"example": "WW",
"description": "The description of the further indication, the possible values are \"WW\" and \"AB\"",
"readOnly": true,
"x-loket-db-field": "dbo.ctNadereAanduiding.Omschrijving"
}
}
},
"postalCode": {
"type": [
"string",
"null"
],
"example": "1234 AA",
"description": "The postal code of the address, only nullable if country is not The Netherlands (NL).",
"minLength": 1,
"maxLength": 9,
"readOnly": false,
"x-loket-db-field": "PostcodeAfwijkend",
"x-loket-implementation": "Indien land = NL moet de postcode aan de regex van NL voldoen (9999 aa)"
},
"location": {
"type": [
"string",
"null"
],
"example": "Fourth floor or building C",
"description": "The location like to further specify the address ",
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "LocatieAfwijkend"
},
"country": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the country. Possible values can be aquired by the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "LandAfwijkend"
},
"value": {
"type": "string",
"example": "Netherlands",
"description": "The name of the country",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.Omschrijving"
},
"isoCode": {
"type": "string",
"example": "NL",
"description": "The ISO 3166-1 alpha-2 value for the country",
"maxLength": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.IsoCode"
}
}
},
"poBox": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 5000,
"description": "Post office box",
"readOnly": false,
"x-loket-db-field": "PostbusAfwijkend"
}
}
},
"contact": {
"type": [
"object",
"null"
],
"readOnly": false,
"properties": {
"name": {
"type": [
"string",
"null"
],
"example": "Henk de Vries",
"description": "Name of the contact of the administration",
"maxLength": 50,
"readOnly": false,
"x-loket-db-field": "Ulsa.Werkgever.ContactpersoonNaam"
},
"phoneNumber": {
"type": [
"string",
"null"
],
"example": "013-12345678",
"description": "The general phone number of the administration",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Ulsa.Werkgever.ContactpersoonTelefoon"
}
}
},
"payrollPeriodType": {
"type": "object",
"readOnly": true,
"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).",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.code"
},
"value": {
"type": "string",
"example": "month",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.omschrijving"
}
}
},
"payrollTaxesNumber": {
"type": [
"string",
"null"
],
"example": "111111110L46",
"minLength": 12,
"maxLength": 12,
"description": "The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst.",
"readOnly": false,
"x-loket-db-field": "Ulsa.Werkgever.LoonheffingenNummer"
},
"claTaxReturnCBSCode": {
"type": "integer",
"format": "int32",
"description": "The CBS code of the CLA (NL: CAO nummer), which is used for payroll tax return purposes.\nIf no CLA is applicable than use the value 9999.\n",
"example": 1896,
"minimum": 1,
"readOnly": false,
"x-loket-db-field": "Ulsa.Werkgever.Cao"
},
"employerId": {
"type": "string",
"format": "uuid",
"description": "The id of the employer to which this payrolladministration belongs.\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"payrollAdministrationGet": {
"type": "object",
"x-loket-implementation": "Bij het teruggeven van administrations dient gelet te worden op de sortering die gebruikt wordt in Loket.prcVerloningList. Hier wordt gesorteerd op Loket.Verloning.DatumIngang en Loket.Verloning.DatumEinde. Deze sortering willen we voor nu hanteren. Mocht dit later niet handig blijken kunnen we beslissen om deze datumvelden in de API op te nemen en de front-end te laten sorteren naar wens. Hier is nu niet voor gekozen omdat deze twee datumvelden buiten de sortering geen betekenis hebben.",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"$ref": "#/components/schemas/name"
},
"shortName": {
"$ref": "#/components/schemas/shortName"
},
"administrationNumber": {
"$ref": "#/components/schemas/administrationNumber"
},
"clientNumber": {
"$ref": "#/components/schemas/clientNumber"
},
"description": {
"$ref": "#/components/schemas/description"
},
"startDate": {
"$ref": "#/components/schemas/startDate"
},
"endDate": {
"$ref": "#/components/schemas/endDate"
},
"cao": {
"$ref": "#/components/schemas/cao"
},
"loonmodel": {
"$ref": "#/components/schemas/loonmodel"
},
"groupClassification": {
"$ref": "#/components/schemas/groupClassification"
},
"groupCode": {
"$ref": "#/components/schemas/groupCode"
},
"address": {
"$ref": "#/components/schemas/address"
},
"deviatingPostalAddress": {
"$ref": "#/components/schemas/deviatingPostalAddress"
},
"contact": {
"$ref": "#/components/schemas/contact"
},
"payrollPeriodType": {
"$ref": "#/components/schemas/payrollPeriodType"
},
"payrollTaxesNumber": {
"$ref": "#/components/schemas/payrollTaxesNumber"
},
"claTaxReturnCBSCode": {
"$ref": "#/components/schemas/claTaxReturnCBSCode"
},
"employerId": {
"$ref": "#/components/schemas/employerId"
}
}
},
"idReadOnlyFalse": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"wageModelPost": {
"type": "object",
"format": "metadata",
"description": "The \"loonmodel\" (this is a Loket term) the payroll administration inherits the payrolling configuration from. Deviating from the loonmodel configuration on payrol administration level is possible.\n\n`loonmodel` is a metadata field within the provider context. Possible values can be managed by the user.",
"properties": {
"id": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"value": {
"type": "string",
"example": "Foresting monthly payrolling",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "ulsa.modelwerkgever.naam"
},
"firstPayrollYear": {
"type": "integer",
"format": "int32",
"example": 2025,
"description": "The first year the wage model is/was active.",
"readOnly": true
},
"currentPayrollYear": {
"type": "integer",
"format": "int32",
"example": 2025,
"description": "Current year the wage model is active.",
"readOnly": true
},
"cla": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "The CAO (CLA -> collective labor agrement) of the \"loonmodel\" the payroll administration is linked to.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 184,
"readOnly": true,
"x-loket-db-field": "Ulsa.ModelWerkgever.ExternId"
},
"value": {
"type": "string",
"example": "Agriculture",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "ulsa.ModelWerkgever.Omschrijving"
}
}
},
"payrollPeriodType": {
"type": "object",
"readOnly": true,
"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).",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.code"
},
"value": {
"type": "string",
"example": "month",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.omschrijving"
}
}
}
}
},
"withholdingParty": {
"type": [
"string",
"null"
],
"example": "ABC accountants",
"description": "Deviating name of the administration for the payroll tax return",
"minLength": 1,
"maxLength": 200,
"readOnly": false
},
"payrollYear": {
"type": "integer",
"format": "int32",
"example": 2025,
"description": "The first year the payroll administration is active.",
"readOnly": false
},
"isInternalPayrollAdministration": {
"type": "boolean",
"example": false,
"description": "Indicates if the payroll administration is used for internal payroll purposes.",
"readOnly": false
},
"testYear": {
"type": "boolean",
"example": false,
"description": "Indicates if the firstPayrollYear for the payroll administration is a test year.",
"readOnly": false
},
"synchronize": {
"type": "object",
"properties": {
"contactInformation": {
"type": "boolean",
"example": false,
"description": "Synchronize contact information from employer to administration",
"readOnly": false
},
"nameAndAddress": {
"type": "boolean",
"example": false,
"description": "Synchronize name and address information from employer to administration",
"readOnly": false
}
}
},
"wageTaxTableColor": {
"type": "object",
"format": "metadata",
"description": "The wage tax table color of the payroll administration.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false
},
"value": {
"type": "string",
"example": "Groene tabel",
"maxLength": 50,
"readOnly": true
}
}
},
"premiumGroup": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Premium group (premiegroep) of the payroll administration.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "(1) Agrarisch bedrijf kort",
"maxLength": 50,
"readOnly": true
}
}
},
"premiumGroupUszo": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Premium group uszo (premiegroep USZO) of the payroll administration.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 61,
"readOnly": false
},
"value": {
"type": "string",
"example": "(61) Overheid, onderwijs en wetenschappen",
"maxLength": 50,
"readOnly": true
}
}
},
"methodOfCreationPayrollTaxReturn": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The method of creation of the payroll tax return.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false
},
"value": {
"type": "string",
"example": "Collective",
"maxLength": 50,
"readOnly": true
}
}
},
"annualPayrollTaxReturn": {
"type": "boolean",
"example": false,
"description": "Indicates if the payroll administration uses an annual payroll tax return.",
"readOnly": false
},
"payrollTaxReturnProcessedBy": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The application that is responsible for the processing (approve or reject) of the payroll tax return.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 6,
"readOnly": false
},
"value": {
"type": "string",
"example": "Loket",
"maxLength": 50,
"readOnly": true
}
}
},
"aofPremiumType": {
"type": "object",
"format": "metadata",
"description": "The AOF premium type of the payroll administration.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false
},
"value": {
"type": "string",
"example": "Kleine werkgever",
"maxLength": 50,
"readOnly": true
}
}
},
"iban": {
"type": [
"string",
"null"
],
"example": "NL91ABNA0417164300",
"description": "IBAN",
"minLength": 1,
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "Ulsa.Werkgever.IBAN"
},
"totalSepaFile": {
"type": "boolean",
"example": false,
"description": "Indicates if the total (a single instead of separate files) SEPA file is used. This is the file that is used for the payment of wages.",
"readOnly": false
},
"payslip": {
"type": "object",
"properties": {
"template": {
"type": "object",
"format": "metadata",
"description": "The template of the payslip. This is a metadata field within the provider context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Standaard met grijstinten",
"maxLength": 50,
"readOnly": true
}
}
},
"displaySalutation": {
"type": "boolean",
"example": false,
"description": "Display salutation on the payslip (yes or no).",
"readOnly": false
},
"displaydisplayPayScale": {
"type": "boolean",
"example": false,
"description": "Display pay scale on the payslip (yes or no).",
"readOnly": false
},
"displayDepartment": {
"type": "boolean",
"example": false,
"description": "Display department on the payslip (yes or no).",
"readOnly": false
},
"addressLocation": {
"type": "object",
"format": "metadata",
"description": "The location of the address on the payslip.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Standaard",
"maxLength": 50,
"readOnly": true
}
}
},
"employeeNumberDisplayMethod": {
"type": "object",
"format": "metadata",
"description": "The employee identification to use on the payslip.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Personeelsnummer",
"maxLength": 50,
"readOnly": true
}
}
},
"functionDisplayMethod": {
"type": "object",
"format": "metadata",
"description": "The way the function is displayed on the payslip",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Functie (Dienstverband)",
"maxLength": 50,
"readOnly": true
}
}
},
"hourlyWageDisplayMethod": {
"type": "object",
"format": "metadata",
"description": "The way the hourly wage is displayed on the payslip",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Uurloon en Periode uurloon",
"maxLength": 50,
"readOnly": true
}
}
},
"employmentStartDateDisplayMethod": {
"type": "object",
"format": "metadata",
"description": "The employment start date to use on the payslip.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Historische datum in dienst",
"maxLength": 50,
"readOnly": true
}
}
},
"employeeNameDisplayMethod": {
"type": "object",
"format": "metadata",
"description": "The way the employee name is displayed on the payslip",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Standaard",
"maxLength": 50,
"readOnly": true
}
}
}
}
},
"defaults": {
"type": "object",
"properties": {
"mdvNotification": {
"type": "boolean",
"example": false,
"description": "Indicate if a Mdv (melding dienstverband) should be send.",
"readOnly": false
},
"employmentDurationType": {
"type": "object",
"format": "metadata",
"description": "A selection of pre defined durations for the employment.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.SoortDienstverband / Contract"
},
"value": {
"type": "string",
"example": "Contract of indefinite duration",
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortDienstverband.Omschrijving"
}
}
},
"typeOfEmployee": {
"type": "object",
"format": "metadata",
"description": "A selection of pre defined employee-types for the employment.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Conceptwerknemer.SoortWerknemer"
},
"value": {
"type": "string",
"example": "Werknemer",
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortWerknemer.Omschrijving"
}
}
},
"employmentContractType": {
"type": "object",
"format": "metadata",
"description": "The type of employment applicable for the employment.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.BasisDienstverband"
},
"value": {
"type": "string",
"example": "Labor agreement",
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisDienstverband.Omschrijving"
}
}
},
"grossWageType": {
"type": "object",
"format": "metadata",
"description": "Indicates whether the `grossWage` is an hourly wage or a Periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in wagePeriodType.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Beloning.BasisloonEenheid"
},
"value": {
"type": "string",
"example": "hourly",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisloonEenheid"
}
}
},
"netWageType": {
"type": "object",
"format": "metadata",
"description": "Indicates whether the net wage is an hourly wage or a periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in the payroll administration resource.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Beloning.NettoloonEenheid"
},
"value": {
"type": "string",
"example": "hourly",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisloonEenheid"
}
}
},
"calculateUsingWorkPattern": {
"type": "object",
"description": "Indications in this objects determine whether specific values should be calculated based on the bi-weekly workPattern (specified in the `workPattern` object).\n",
"properties": {
"hoursBrokenPeriod": {
"type": "boolean",
"example": false,
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.BerekenenUrenGebrokenPeriodeViaRooster"
},
"hoursRegularPeriod": {
"type": "boolean",
"example": false,
"description": "Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods.",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.BerekenenUrenPeriodeViaRooster"
},
"daysDailyRate": {
"type": "boolean",
"example": false,
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.DagenDagvergoedingViaRooster"
},
"deviatingDaysAndHours": {
"type": "boolean",
"example": false,
"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)!",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.AfwijkendeDagenUrenViaRooster"
}
}
}
}
},
"payrollAdministrationPost": {
"type": "object",
"properties": {
"wageModel": {
"$ref": "#/components/schemas/wageModelPost"
},
"administrationNumber": {
"$ref": "#/components/schemas/administrationNumber"
},
"groupCode": {
"$ref": "#/components/schemas/groupCode"
},
"name": {
"$ref": "#/components/schemas/name"
},
"shortName": {
"$ref": "#/components/schemas/shortName"
},
"description": {
"$ref": "#/components/schemas/description"
},
"withholdingParty": {
"$ref": "#/components/schemas/withholdingParty"
},
"groupClassification": {
"$ref": "#/components/schemas/groupClassification"
},
"payrollYear": {
"$ref": "#/components/schemas/payrollYear"
},
"isInternalPayrollAdministration": {
"$ref": "#/components/schemas/isInternalPayrollAdministration"
},
"testYear": {
"$ref": "#/components/schemas/testYear"
},
"synchronize": {
"$ref": "#/components/schemas/synchronize"
},
"address": {
"$ref": "#/components/schemas/address"
},
"deviatingPostalAddress": {
"$ref": "#/components/schemas/deviatingPostalAddress"
},
"contact": {
"$ref": "#/components/schemas/contact"
},
"payrollTaxesNumber": {
"$ref": "#/components/schemas/payrollTaxesNumber"
},
"wageTaxTableColor": {
"$ref": "#/components/schemas/wageTaxTableColor"
},
"premiumGroup": {
"$ref": "#/components/schemas/premiumGroup"
},
"premiumGroupUszo": {
"$ref": "#/components/schemas/premiumGroupUszo"
},
"methodOfCreationPayrollTaxReturn": {
"$ref": "#/components/schemas/methodOfCreationPayrollTaxReturn"
},
"annualPayrollTaxReturn": {
"$ref": "#/components/schemas/annualPayrollTaxReturn"
},
"payrollTaxReturnProcessedBy": {
"$ref": "#/components/schemas/payrollTaxReturnProcessedBy"
},
"aofPremiumType": {
"$ref": "#/components/schemas/aofPremiumType"
},
"claTaxReturnCBSCode": {
"$ref": "#/components/schemas/claTaxReturnCBSCode"
},
"iban": {
"$ref": "#/components/schemas/iban"
},
"totalSepaFile": {
"$ref": "#/components/schemas/totalSepaFile"
},
"payslip": {
"$ref": "#/components/schemas/payslip"
},
"defaults": {
"$ref": "#/components/schemas/defaults"
}
}
},
"payrollAdministrationPostResponse": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
},
"payrollAdministrationConfiguration": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Bakker",
"description": "Description of the administration",
"maxLength": 50,
"readOnly": false
},
"clientNumber": {
"$ref": "#/components/schemas/clientNumber"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2023-01-01",
"description": "The first day the administration is active.\n",
"readOnly": true
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2025-12-31",
"description": "The last day the administration is active.\n",
"readOnly": false
},
"payrollPeriodType": {
"type": "object",
"format": "metadata",
"description": "Indicates the frequence of the payrolling process.",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true
},
"value": {
"type": "string",
"example": "month",
"maxLength": 50,
"readOnly": true
}
}
},
"holidayAllowanceBaseForCalculation": {
"type": "object",
"format": "metadata",
"description": "holidayAllowanceBaseForCalculation",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Basisloon",
"maxLength": 50,
"readOnly": true
}
}
},
"yearEndBaseForCalculation": {
"type": "object",
"format": "metadata",
"description": "yearEndBaseForCalculation",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Basisloon",
"maxLength": 50,
"readOnly": true
}
}
},
"holidayAllowancePercentage": {
"type": "number",
"format": "double",
"example": 40,
"description": "The percentage of the holidayAllowance.\n",
"minimum": 0,
"maximum": 100,
"readOnly": false
},
"yearEndPercentage": {
"type": "number",
"format": "double",
"example": 40,
"description": "The percentage of the year end bonus.\n",
"minimum": 0,
"maximum": 100,
"readOnly": false
},
"synchronize": {
"type": "object",
"properties": {
"contactInformation": {
"type": "boolean",
"example": false,
"description": "Synchronize contact information from employer to administration",
"readOnly": false
},
"nameAndAddress": {
"type": "boolean",
"example": false,
"description": "Synchronize name and address information from employer to administration",
"readOnly": false
}
}
},
"defaults": {
"type": "object",
"properties": {
"employmentDurationType": {
"type": "object",
"format": "metadata",
"description": "A selection of pre defined durations for the employment.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.SoortDienstverband / Contract"
},
"value": {
"type": "string",
"example": "Contract of indefinite duration",
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortDienstverband.Omschrijving"
}
}
},
"typeOfEmployee": {
"type": "object",
"format": "metadata",
"description": "A selection of pre defined employee-types for the employment.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Conceptwerknemer.SoortWerknemer"
},
"value": {
"type": "string",
"example": "Werknemer",
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortWerknemer.Omschrijving"
}
}
},
"employmentContractType": {
"type": "object",
"format": "metadata",
"description": "The type of employment applicable for the employment.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.BasisDienstverband"
},
"value": {
"type": "string",
"example": "Labor agreement",
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisDienstverband.Omschrijving"
}
}
},
"grossWageType": {
"type": "object",
"format": "metadata",
"description": "Indicates whether the `grossWage` is an hourly wage or a Periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in wagePeriodType.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Beloning.BasisloonEenheid"
},
"value": {
"type": "string",
"example": "hourly",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisloonEenheid"
}
}
},
"netWageType": {
"type": "object",
"format": "metadata",
"description": "Indicates whether the net wage is an hourly wage or a periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in the payroll administration resource.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Beloning.NettoloonEenheid"
},
"value": {
"type": "string",
"example": "hourly",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisloonEenheid"
}
}
},
"mdvNotification": {
"type": "boolean",
"example": false,
"description": "Indicate if a Mdv (melding dienstverband) should be send.",
"readOnly": false
},
"calculateUsingWorkPattern": {
"type": "object",
"description": "Indications in this objects determine whether specific values should be calculated based on the bi-weekly workPattern (specified in the `workPattern` object).\n",
"properties": {
"hoursBrokenPeriod": {
"type": "boolean",
"example": false,
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.BerekenenUrenGebrokenPeriodeViaRooster"
},
"hoursRegularPeriod": {
"type": "boolean",
"example": false,
"description": "Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods.",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.BerekenenUrenPeriodeViaRooster"
},
"daysDailyRate": {
"type": "boolean",
"example": false,
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.DagenDagvergoedingViaRooster"
},
"deviatingDaysAndHours": {
"type": "boolean",
"example": false,
"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)!",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.AfwijkendeDagenUrenViaRooster"
}
}
},
"payslipAvailableForEmployeeDay": {
"type": "integer",
"example": 20,
"description": "The default day (number) of the period on which payslips will be made available for employees. \n",
"minimum": 0,
"maximum": 31,
"readOnly": false
},
"componentSet": {
"type": "object",
"properties": {
"payrollPeriodDataCollectiveCategory": {
"type": [
"object",
"null"
],
"description": "The default category for the browser variabele gegevens. Either this field or the payrollPeriodDataCollectiveComponentSet field can be filled.",
"properties": {
"key": {
"type": "integer",
"readOnly": false
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true
}
}
},
"payrollPeriodDataCollectiveComponentSet": {
"type": [
"object",
"null"
],
"description": "The default exportset for the browser variabele gegevens. Either this field or the payrollPeriodDataCollectiveCategory field can be filled.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": false
},
"description": {
"type": "string",
"example": "Standaard exportset",
"readOnly": true
},
"registrationLevel": {
"type": "string",
"enum": [
"provider",
"employer"
],
"description": "The level at which the set is defined.",
"readOnly": true
}
}
},
"payrollPeriodDataIndividual": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": false
},
"description": {
"type": "string",
"example": "Standaard exportset",
"readOnly": true
},
"registrationLevel": {
"type": "string",
"enum": [
"provider",
"employer"
],
"description": "The level at which the set is defined.",
"readOnly": true
}
}
},
"payrollPeriodDataLeave": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": false
},
"description": {
"type": "string",
"example": "Standaard exportset",
"readOnly": true
},
"registrationLevel": {
"type": "string",
"enum": [
"provider",
"employer"
],
"description": "The level at which the set is defined.",
"readOnly": true
}
}
},
"payrollPeriodDataWerkkosten": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": false
},
"description": {
"type": "string",
"example": "Standaard exportset",
"readOnly": true
},
"registrationLevel": {
"type": "string",
"enum": [
"provider",
"employer"
],
"description": "The level at which the set is defined.",
"readOnly": true
}
}
},
"payrollPeriodDataEmployeeSelfService": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": false
},
"description": {
"type": "string",
"example": "Standaard exportset",
"readOnly": true
},
"registrationLevel": {
"type": "string",
"enum": [
"provider",
"employer"
],
"description": "The level at which the set is defined.",
"readOnly": true
}
}
}
}
}
}
}
}
},
"automaticPayrollConfiguration": {
"properties": {
"planDuringWeekend": {
"type": "boolean",
"example": false,
"description": "Indicates whether processes can be planned during the weekend.\n"
},
"planDuringHoliday": {
"type": "boolean",
"example": false,
"description": "Indicates whether processes can be planned during a holiday.\n"
},
"planBeforeOrAfterWeekend": {
"type": [
"string",
"null"
],
"enum": [
"Before",
"After"
],
"example": "After",
"description": "Indicates whether the process should be planned before or after the weekend.\n"
},
"planBeforeOrAfterHoliday": {
"type": [
"string",
"null"
],
"enum": [
"Before",
"After"
],
"example": "Before",
"description": "Indicates whether the process should be planned before or after the holiday.\n"
},
"processes": {
"type": "array",
"items": {
"properties": {
"type": {
"type": "object",
"format": "metadata",
"description": "The process. \n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Verlonen",
"readOnly": true
}
}
},
"isEnabled": {
"type": "boolean",
"example": false,
"description": "Indicates whether the process is automated.\n"
},
"dayNumber": {
"type": [
"integer",
"null"
],
"example": 2,
"description": "The day of the period on which to start the process.\n",
"readOnly": false
},
"additionalNumberOfDaysFirstPeriod": {
"type": [
"integer",
"null"
],
"example": 2,
"description": "Additional days to add to the day of the period on which to start the process, in the first period.\n",
"readOnly": false
},
"additionalNumberOfDaysLastPeriod": {
"type": [
"integer",
"null"
],
"example": 2,
"description": "Additional days to add to the day of the period on which to start the process, in the last period.\n",
"readOnly": false
},
"processInNextPeriod": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Indicates whether the process should be executed in the next period.\n"
}
}
}
}
}
},
"automaticPayrollDates": {
"properties": {
"type": {
"type": "object",
"format": "metadata",
"description": "The process. \n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Verlonen",
"readOnly": true
}
}
},
"dates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"payrollPeriod": {
"type": "object",
"readOnly": true,
"properties": {
"year": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"periodNumber": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period to which the payroll period data applies\n",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period to which the payroll period data applies\n",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
}
}
},
"scheduledDate": {
"type": "string",
"format": "date",
"example": "2020-01-01",
"description": "The date on which the process should be executed.\n"
},
"methodOfCreation": {
"type": "object",
"description": "Indicates how the date was recorded. Either manually or automatically.",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The key indicating how the date was recorded",
"readOnly": true
},
"value": {
"type": "string",
"example": "Individueel",
"description": "The value describing how the date was recorded",
"readOnly": true
}
}
},
"isProcessed": {
"type": "boolean",
"example": false,
"description": "Indicates whether the process is executed.\n"
}
}
}
}
}
},
"automaticPayrollDatePost": {
"properties": {
"type": {
"type": "object",
"format": "metadata",
"description": "The process. \n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
}
}
},
"payrollPeriod": {
"type": "object",
"properties": {
"periodNumber": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
}
}
},
"scheduledDate": {
"type": "string",
"format": "date",
"example": "2020-01-01",
"description": "The date on which the process should be executed.\n"
}
}
},
"automaticPayrollDatePut": {
"properties": {
"scheduledDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2020-01-01",
"description": "The date on which the process should be executed.\n"
}
}
},
"authorizationModel": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"maxLength": 50,
"example": "GetWagesByEmploymentId",
"description": "The description of the activity.",
"readOnly": false
},
"functionalDescription": {
"type": "string",
"example": "Ophalen van de salarisgegevens van een medewerker",
"readOnly": true
},
"authorizations": {
"type": "array",
"description": "The authorizations that give access to the activity. Only one authorization is nesseccary to have access to the activity.",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Beheer arbeidsvoorwaarden",
"readOnly": true
}
}
}
},
"modules": {
"type": "array",
"description": "The modules that give access to the activity. Only one module is nesseccary to have access to the activity.",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Personeelsregistratie",
"readOnly": true
}
}
}
},
"roles": {
"type": "array",
"description": "The roles that give access to the activity. Only one role is nesseccary to have access to the activity.",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Provider",
"readOnly": true
}
}
}
}
}
},
"nonPayrollAdministration": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Bakker",
"description": "Description of the administration",
"maxLength": 50,
"readOnly": false,
"x-loket-db-field": "Loket.Verloning.Omschrijving"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2016-01-01",
"description": "The first day the administration is active.\n",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2020-12-31",
"description": "The last day the administration is active.\n",
"readOnly": false
},
"fulltimeHours": {
"type": "number",
"format": "double",
"example": 40,
"description": "The weekly working hours.\n",
"minimum": 0,
"maximum": 99.99,
"readOnly": false
},
"cao": {
"type": "object",
"format": "metadata",
"description": "The CAO (CLA -> collective labor agrement).",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 184,
"readOnly": false
},
"value": {
"type": "string",
"example": "Agriculture",
"maxLength": 50,
"readOnly": true
}
}
},
"payrollPeriodType": {
"type": "object",
"format": "metadata",
"description": "Indicates the frequence of the payrolling process.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false
},
"value": {
"type": "string",
"example": "month",
"maxLength": 50,
"readOnly": true
}
}
},
"holidayAllowanceBaseForCalculation": {
"type": "object",
"format": "metadata",
"description": "holidayAllowanceBaseForCalculation",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Basisloon",
"maxLength": 50,
"readOnly": true
}
}
},
"yearEndBaseForCalculation": {
"type": "object",
"format": "metadata",
"description": "yearEndBaseForCalculation",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Basisloon",
"maxLength": 50,
"readOnly": true
}
}
},
"holidayAllowancePercentage": {
"type": "number",
"format": "double",
"example": 40,
"description": "The percentage of the holidayAllowance.\n",
"minimum": 0,
"maximum": 100,
"readOnly": false
},
"yearEndPercentage": {
"type": "number",
"format": "double",
"example": 40,
"description": "The percentage of the year end bonus.\n",
"minimum": 0,
"maximum": 100,
"readOnly": false
}
}
},
"nonPayrollAdministrationPut": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Bakker",
"description": "Description of the administration",
"maxLength": 50,
"readOnly": false,
"x-loket-db-field": "Loket.Verloning.Omschrijving"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2020-12-31",
"description": "The last day the administration is active.\n",
"readOnly": false
},
"fulltimeHours": {
"type": "number",
"format": "double",
"example": 40,
"description": "The weekly working hours.\n",
"minimum": 0,
"maximum": 99.99,
"readOnly": false
},
"cao": {
"type": "object",
"format": "metadata",
"description": "The CAO (CLA -> collective labor agrement).",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 184,
"readOnly": false
},
"value": {
"type": "string",
"example": "Agriculture",
"maxLength": 50,
"readOnly": true
}
}
},
"holidayAllowanceBaseForCalculation": {
"type": "object",
"format": "metadata",
"description": "holidayAllowanceBaseForCalculation",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Basisloon",
"maxLength": 50,
"readOnly": true
}
}
},
"yearEndBaseForCalculation": {
"type": "object",
"format": "metadata",
"description": "yearEndBaseForCalculation",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Basisloon",
"maxLength": 50,
"readOnly": true
}
}
},
"holidayAllowancePercentage": {
"type": [
"number",
"null"
],
"format": "double",
"example": 40,
"description": "The percentage of the holidayAllowance.\n",
"minimum": 0,
"maximum": 100,
"readOnly": false
},
"yearEndPercentage": {
"type": [
"number",
"null"
],
"format": "double",
"example": 40,
"description": "The percentage of the year end bonus.\n",
"minimum": 0,
"maximum": 100,
"readOnly": false
}
}
},
"payrollComponentSets": {
"type": "object",
"description": "The payroll component sets",
"readOnly": false,
"properties": {
"id": {
"type": [
"string",
"null"
],
"format": "uuid",
"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\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true,
"x-loket-db-field": "Loket.WerkgeverExportSet & Ulsa.ExportSet",
"x-loket-implementation1": "Waarden komen uit 2 tabellen Loket.WerkgeverExportset (afh. van WerkgeverId+VerloningId) & Ulsa.Exportset (afh. van ProviderId). Als uit Ulsa.Exportset dan id opslaan als negatief getal, als uit WerkgeverExportSet dan id opslaan als positief getal.",
"x-loket-implementation3": "Het endpoint geeft alleen sets terug waarbij soort ([Ulsa].[ExportSet].[Soort] of Loket.WerkgeverExportset.soort)= 1 (algemeen) of 2 (werkkosten)"
},
"description": {
"type": "string",
"example": "Standaard exportset",
"readOnly": false,
"maxLength": 50,
"x-loket-db-field": "bijbehorende omschrijving van betreffende set (let op; dit moet overeenkomen met de beschrijving op administratie-niveau ook al is de set op providerniveau vastgelegd)."
},
"payrollComponents": {
"type": "array",
"items": {
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Component",
"x-loket-comment": "Let op! Toon alleen de componenten die voorkomen in exportset EN voorkomen op het actieve jaar van verloning voor deze administratie. Dit geldt zowel voor sets die op provider als administratie niveau gedefinieerd zijn."
},
"description": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Categorie"
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true,
"x-loket-db-field": "dbo.ctCategorie.omschrijving"
}
}
},
"deductionOrPayment": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"x-loket-implementation": "Indien Ulsa.Component.BetalingInhouding de waarde 0 heeft NULL teruggeven.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.BetalingInhouding"
},
"value": {
"type": "string",
"example": "Betaling",
"readOnly": true,
"x-loket-db-field": "dbo.ctBetalingInhouding"
}
}
},
"canBeSupplemented": {
"type": "boolean",
"example": false,
"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.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.ComponentAlgemeen.AanvullendMogelijk",
"x-loket-implementation": "1 (ja) = true en 2 (nee) = false"
}
}
}
}
}
},
"availablePayrollComponentSets": {
"allOf": [
{
"$ref": "#/components/schemas/payrollComponentSets"
},
{
"properties": {
"type": {
"type": "object",
"readOnly": false,
"format": "metadata",
"description": "The type of the componentset. (Loonresultaten, Werkkosten, VerlofOpbouw)",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Loonresultaten",
"readOnly": true
}
}
},
"isDefinedOnProviderLevel": {
"type": "boolean",
"example": true,
"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.\n",
"readOnly": true
},
"isDefaultForPayrollPeriodData": {
"type": "boolean",
"example": true,
"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.\n",
"readOnly": true,
"x-loket-implementation": "True als het id staat ingesteld bij loket.verloning.StandaardExportSetCodeVarGegIndividueel anders false"
},
"isDefaultForBrowserPayrollPeriodData": {
"type": "boolean",
"example": false,
"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.\n",
"readOnly": true,
"x-loket-implementation": "True als het id staat ingesteld bij loket.verloning.StandaardExportSetCodeBrowserVarGeg anders false"
}
}
}
]
},
"payrollComponentSetsGetPost": {
"allOf": [
{
"$ref": "#/components/schemas/payrollComponentSets"
},
{
"properties": {
"type": {
"type": "object",
"readOnly": false,
"format": "metadata",
"description": "The type of the componentset. (Loonresultaten, Werkkosten, VerlofOpbouw)",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Loonresultaten",
"readOnly": true
}
}
}
}
}
]
},
"payrollComponents": {
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Component",
"x-loket-comment": "Let op! Toon alleen de componenten die voorkomen in exportset EN voorkomen op het actieve jaar van verloning voor deze administratie. Dit geldt zowel voor sets die op provider als administratie niveau gedefinieerd zijn."
},
"description": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Categorie"
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true,
"x-loket-db-field": "dbo.ctCategorie.omschrijving"
}
}
},
"deductionOrPayment": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"x-loket-implementation": "Indien Ulsa.Component.BetalingInhouding de waarde 0 heeft NULL teruggeven.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.BetalingInhouding"
},
"value": {
"type": "string",
"example": "Betaling",
"readOnly": true,
"x-loket-db-field": "dbo.ctBetalingInhouding"
}
}
},
"canBeSupplemented": {
"type": "boolean",
"example": false,
"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.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.ComponentAlgemeen.AanvullendMogelijk",
"x-loket-implementation": "1 (ja) = true en 2 (nee) = false"
},
"isCollectiveMutationPossible": {
"type": "boolean",
"example": false,
"description": "Indicates whether the component can be mutated collective.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.ComponentAlgemeen.CollectieveMutatieMogelijk"
}
}
},
"employmentFunds": {
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the employment fund.\n",
"readOnly": false
},
"description": {
"type": "string",
"example": "Aanvullende pensioenregeling",
"description": "The description of the employment fund.\n",
"maxLength": 255,
"readOnly": true
}
}
},
"abpFunds": {
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the abp fund.\n",
"readOnly": false
},
"description": {
"type": "string",
"example": "Aanvullende pensioenregeling",
"description": "The description of the abp fund.\n",
"maxLength": 255,
"readOnly": true
}
}
},
"collectiveAction": {
"type": "object",
"properties": {
"collectiveActionId": {
"$ref": "#/components/schemas/id"
},
"submittedByUserId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"submittedOn": {
"type": "string",
"format": "date-time",
"example": "2023-05-08T15:16:49+02:00",
"description": "Date-time when the collectiveAction was submitted.",
"readOnly": true
},
"collectiveActionParentId": {
"type": "string",
"format": "uuid",
"description": "The parentId is used to link the collectiveAction to a parent collectiveAction.\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"employerId": {
"type": "string",
"format": "uuid",
"description": "The employer for which the collectiveAction was submitted.\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"payrollAdministrationId": {
"type": "string",
"format": "uuid",
"description": "The payroll administration for which the collectiveAction was submitted.\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"status": {
"type": "string",
"enum": [
"Completed",
"NotStarted",
"InProgress"
],
"description": "status of the collectiveAction",
"readOnly": true
},
"type": {
"type": "string",
"enum": [
"Werknemerloket",
"Beloning"
],
"description": "the type of collectiveAction",
"readOnly": true
},
"itemCount": {
"type": "object",
"format": "metadata",
"description": "Summary of the items in the collective action.",
"readOnly": true,
"properties": {
"processedWithError": {
"type": "integer",
"format": "int32",
"example": 10,
"description": "The number of items in the collectiveAction that were processed unsuccessfully and resulted in an error.",
"readOnly": true
},
"processed": {
"type": "integer",
"format": "int32",
"example": 75,
"description": "The number of items in the collectiveAction that were processed successfully without a warning.",
"readOnly": true
},
"processedWithWarning": {
"type": "integer",
"format": "int32",
"example": 15,
"description": "The number of items in the collectiveAction that were processed successfully with a warning.",
"readOnly": true
},
"total": {
"type": "integer",
"format": "int32",
"example": 100,
"description": "The total number of items in the collectiveAction.",
"readOnly": true
}
}
}
}
},
"idNullable": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"collectiveActionDetail": {
"type": "object",
"description": "List of all items in the collective action.",
"properties": {
"collectiveActionItemId": {
"$ref": "#/components/schemas/id"
},
"createdOn": {
"type": "string",
"format": "date-time",
"example": "2023-05-08T15:16:49+02:00",
"description": "Date-time when the collectiveActionItem was created.",
"readOnly": true
},
"succes": {
"type": "boolean",
"example": true,
"description": "status of the collectiveActionItem",
"readOnly": true
},
"collectiveActionType": {
"type": "string",
"enum": [
"Werknemerloket",
"Beloning",
"etc."
],
"description": "the type of collectiveAction",
"readOnly": true
},
"entityId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of the entity to which the item applies. If the collectiveActionType = 'Werknemerloket' then entityId contains an employeeId. In all other cases, the entityId contains an employmentId\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"employerId": {
"$ref": "#/components/schemas/idNullable"
},
"payrollAdministrationId": {
"$ref": "#/components/schemas/idNullable"
},
"employmentId": {
"$ref": "#/components/schemas/idNullable"
},
"messages": {
"type": [
"array",
"null"
],
"description": "array of messages of an collectiveactionitem.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "BrokenBusinessRule",
"description": "Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)"
},
"description": {
"type": "string",
"example": "Invalid value for ",
"description": "Describes the message"
},
"id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity",
"example": "904d6856-6034-4624-bcbc-886188c115c5"
},
"code": {
"type": "integer",
"format": "int32",
"description": "Identifying code for the message",
"example": 12
},
"properties": {
"type": "array",
"minimum": 0,
"description": "An array that can contain additional information",
"items": {
"type": "string"
}
}
}
}
}
}
},
"payrollData": {
"properties": {
"employment": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"payrollId": {
"type": "integer",
"format": "int32",
"example": 2,
"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.",
"readOnly": true,
"x-loket-db-field": "Loket.Dienstverband.PersoneelsnummerVerloning"
},
"incomeRelationshipNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"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.",
"minimum": 0,
"maximum": 9999,
"readOnly": true,
"x-loket-db-field": "Loket.Dienstverband.NummerInkomstenVerhouding"
}
}
},
"employee": {
"type": "object",
"properties": {
"formattedName": {
"type": "string",
"example": "Jong, I",
"description": "preformated user name for displaying. \\\\\", \\\"\\\\\" \\\"\\",
"readOnly": true
},
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 156,
"minimum": 1,
"description": "The employee number to uniquely identify an employee within an employer\n",
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.Personeelsnummer"
},
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name, given name, forename or Christian name as part of a persons personal name.\n",
"minLength": 1,
"maxLength": 28,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Roepnaam"
}
}
},
"payrollPeriod": {
"type": "object",
"format": "metadata",
"readOnly": true,
"x-loket-implementation": "De twee waardes kunnen vertaald worden naar Loket.Loontransactie.PeriodeID dan zal er wel voor gezorgd moeten worden dat periode altijd uit 2 cijfers bestaat het is nu een int dus mogelijk moet periode een number worden",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period in which the payroll data is to be processed\n",
"example": 2017,
"minimum": 2000,
"maximum": 9999,
"readOnly": true,
"x-loket-db-field": "eerste 4 cijfers van Loket.Loontransactie.PeriodeID"
},
"periodNumber": {
"type": "integer",
"format": "int32",
"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.\n",
"example": 1,
"minimum": 1,
"maximum": 53,
"readOnly": true,
"x-loket-db-field": "Laatste 2 cijfers van Loket.Loontransactie.PeriodeID",
"x-loket-implementation": "Bij het updaten/inserten van dit veld eventueel een leading 0 toevoegen aan het periodenummer als deze kleiner is dan 10. Zodat PeriodeID in de database altijd 6 cijfers bevat met als formatting yyyymm, bijvoorbeeld 201807"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period to which the payroll period data applies\n",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period to which the payroll period data applies\n",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
}
}
},
"shift": {
"type": "object",
"format": "metadata",
"description": "The shift determines the full-time hours and bonus percentage.\n",
"properties": {
"shiftNumber": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the shift. Loket supports a maximum of 15 shifts per payroll administration.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.Ploeg.PloegId",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. Let wel op dat het ID meerdere malen voor kan komen in Ulsa omdat het daar uniek is in combinatie met verlongingsperiodeID"
},
"fullTimeHoursPerWeek": {
"type": "number",
"example": 40,
"description": "The full time hours for an employment that is linked to this shift.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.Ploeg.Uren"
},
"bonusPercentage": {
"type": "number",
"example": 12,
"description": "The bonus percentage used in wage calculations for the hours made in this shift.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.Ploeg.Percentage"
}
}
},
"payslipType": {
"type": "object",
"format": "metadata",
"description": "The type of payslip (as defined by the Dutch tax authorities)\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.Loontransactie.Strook"
},
"value": {
"type": "string",
"example": "Bijzonder tarief strook",
"readOnly": true,
"x-loket-db-field": "dbo.ctStrook.Omschrijving"
}
}
},
"distributionUnit": {
"type": "object",
"format": "metadata",
"description": "Distribution unit, used in several reports and the \"basic wage journal\" functionality. Commonly used as a cost center.\n",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "Loket.VerdelingsEenheid.ExternId"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.Nummer"
},
"description": {
"type": "string",
"example": "Sales",
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.Omschrijving"
}
}
},
"costCenter": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost center on which the payroll period data for this record will be booked for the ledger.\n",
"x-loket-implementation": "er zit overerving in de logica voor het ophalen van de waardes van de kostenplaats. null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.KostenplaatsID",
"x-loket-implementation": "Kan geen GUID zijn vanwege de overerving. De code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "SAL073",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Sales Den Bosch",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"costUnit": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost unit on which the data for this record will be booked for the ledger\n",
"x-loket-implementation": "er zit overerving in de logica voor het ophalen van de waardes van de kostendrager. null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.KostenDragerID",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. en code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "01",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Cars",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"payrollComponents": {
"type": "array",
"minimum": 0,
"items": {
"type": "object",
"properties": {
"payrollComponent": {
"type": "object",
"format": "metadata",
"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.
Please note: Business rules may differ per component! Understanding these business rules and corresponding validations requires functional knowledge of Loket.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know it by heart.\n",
"readOnly": false,
"x-loket-db-field": "Loket.LoontransactieMutatie.ComponentID"
},
"description": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
},
"deviatingDescription": {
"type": [
"string",
"null"
],
"example": "Hoeveelheid uren productief",
"description": "A longer and more user-friendly description of the payroll component.\n",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Ulsa.ComponentNaamAfwijkend (database view)"
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Categorie"
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true,
"x-loket-db-field": "dbo.ctCategorie.omschrijving"
}
}
},
"deductionOrPayment": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"x-loket-implementation": "Indien Ulsa.Component.BetalingInhouding de waarde 0 heeft NULL teruggeven.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.BetalingInhouding"
},
"value": {
"type": "string",
"example": "Betaling",
"readOnly": true,
"x-loket-db-field": "dbo.ctBetalingInhouding"
}
}
},
"canBeSupplemented": {
"type": "boolean",
"example": false,
"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.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.ComponentAlgemeen.AanvullendMogelijk",
"x-loket-implementation": "1 (ja) = true en 2 (nee) = false"
}
}
},
"value": {
"type": [
"number",
"null"
],
"example": 144,
"description": "Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules).\n",
"readOnly": false
},
"isSupplement": {
"type": [
"boolean",
"null"
],
"example": false,
"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).\n\n* 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.\n\n* 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.\n\nThis boolean can only be set to `true` in components for which `payrollComponent.canBesupplemented = true`.\n",
"readOnly": false,
"x-loket-implementation": "Wanneer de waarde true is, dient de mutatie opgeslagen te worden met attribuut Aanvullend (code 2 in dbo.ctLoontransactie). Wanneer de waarde false is && value == 0 dan dient de mutatie opgeslagen te worden met atttribuut Nul (code 1 in dbo.ctLoontransactie). Wanneer de waarde false is && value != 0 dan dient de mutatie opgeslagen te worden met attribuut Vervangend (code 0 in dbo.ctLoontransactie)."
}
}
}
}
}
},
"payrollData-2": {
"properties": {
"employment": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"payrollId": {
"type": "integer",
"format": "int32",
"example": 2,
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.PersoneelsnummerVerloning"
},
"incomeRelationshipNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"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.",
"minimum": 0,
"maximum": 9999,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.NummerInkomstenVerhouding"
}
}
},
"employee": {
"type": "object",
"properties": {
"formattedName": {
"type": "string",
"example": "Jong, I",
"description": "Preformatted user name for displaying. `, `",
"readOnly": false
},
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 156,
"minimum": 1,
"description": "The employee number to uniquely identify an employee within an employer.\n",
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Personeelsnummer"
},
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name, given name, forename or Christian name as part of a persons personal name.\n",
"minLength": 1,
"maxLength": 28,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Roepnaam"
}
}
},
"payrollPeriod": {
"type": "object",
"format": "metadata",
"readOnly": false,
"x-loket-implementation": "De twee waardes kunnen vertaald worden naar Loket.Loontransactie.PeriodeID dan zal er wel voor gezorgd moeten worden dat periode altijd uit 2 cijfers bestaat het is nu een int dus mogelijk moet periode een number worden",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period in which the payroll data is to be processed.\n",
"example": 2025,
"minimum": 2000,
"maximum": 9999,
"readOnly": false,
"x-loket-db-field": "eerste 4 cijfers van Loket.Loontransactie.PeriodeID"
},
"periodNumber": {
"type": "integer",
"format": "int32",
"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.\n",
"example": 10,
"minimum": 1,
"maximum": 53,
"readOnly": false,
"x-loket-db-field": "Laatste 2 cijfers van Loket.Loontransactie.PeriodeID",
"x-loket-implementation": "Bij het updaten/inserten van dit veld eventueel een leading 0 toevoegen aan het periodenummer als deze kleiner is dan 10. Zodat PeriodeID in de database altijd 6 cijfers bevat met als formatting yyyymm, bijvoorbeeld 201807"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period to which the payroll period data applies.\n",
"example": "2025-10-01",
"readOnly": false,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period to which the payroll period data applies.\n",
"example": "2025-10-31",
"readOnly": false,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
}
}
},
"shift": {
"type": "object",
"format": "metadata",
"description": "The shift determines the full-time hours and bonus percentage.\n",
"properties": {
"shiftNumber": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the shift. Loket supports a maximum of 15 shifts per payroll administration.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.Ploeg.PloegId",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. Let wel op dat het ID meerdere malen voor kan komen in Ulsa omdat het daar uniek is in combinatie met verlongingsperiodeID"
},
"fullTimeHoursPerWeek": {
"type": "number",
"example": 40,
"description": "The full time hours for an employment that is linked to this shift.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.Ploeg.Uren"
},
"bonusPercentage": {
"type": "number",
"example": 12,
"description": "The bonus percentage used in wage calculations for the hours made in this shift.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.Ploeg.Percentage"
}
}
},
"payslipType": {
"type": "object",
"format": "metadata",
"description": "The type of payslip (as defined by the Dutch tax authorities).\n",
"readOnly": false,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.Strook"
},
"value": {
"type": "string",
"example": "Bijzonder tarief strook",
"readOnly": false,
"x-loket-db-field": "dbo.ctStrook.Omschrijving"
}
}
},
"distributionUnit": {
"type": "object",
"format": "metadata",
"description": "Distribution unit, used in several reports and the \"basic wage journal\" functionality. Commonly used as a cost center.\n",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID).\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "Loket.VerdelingsEenheid.ExternId"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.VerdelingsEenheid.Nummer"
},
"description": {
"type": "string",
"example": "Sales",
"readOnly": false,
"x-loket-db-field": "Loket.VerdelingsEenheid.Omschrijving"
}
}
},
"costCenter": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost center on which the payroll period data for this record will be booked for the ledger.\n",
"x-loket-implementation": "er zit overerving in de logica voor het ophalen van de waardes van de kostenplaats. null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.KostenplaatsID",
"x-loket-implementation": "Kan geen GUID zijn vanwege de overerving. De code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "SAL073",
"readOnly": false,
"x-loket-db-field": "Ulsa.Kostenplaats.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Sales Den Bosch",
"readOnly": false,
"x-loket-db-field": "Ulsa.Kostenplaats.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"costUnit": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost unit on which the data for this record will be booked for the ledger.\n",
"x-loket-implementation": "er zit overerving in de logica voor het ophalen van de waardes van de kostendrager. null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.KostenDragerID",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. en code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "01",
"readOnly": false,
"x-loket-db-field": "Ulsa.Kostendrager.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Cars",
"readOnly": false,
"x-loket-db-field": "Ulsa.Kostendrager.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"payrollComponents": {
"type": "array",
"minimum": 0,
"items": {
"type": "object",
"properties": {
"payrollComponent": {
"type": "object",
"format": "metadata",
"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.
Please note: Business rules may differ per component! Understanding these business rules and corresponding validations requires functional knowledge of Loket.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know it by heart.\n",
"readOnly": false,
"x-loket-db-field": "Loket.LoontransactieMutatie.ComponentID"
},
"description": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component.\n",
"maxLength": 14,
"readOnly": false,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
},
"deviatingDescription": {
"type": [
"string",
"null"
],
"example": "Hoeveelheid uren productief",
"description": "A longer and more user-friendly description of the payroll component.\n",
"maxLength": 50,
"readOnly": false,
"x-loket-db-field": "Ulsa.ComponentNaamAfwijkend (database view)"
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.\n",
"readOnly": false,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Ulsa.Component.Categorie"
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": false,
"x-loket-db-field": "dbo.ctCategorie.omschrijving"
}
}
},
"deductionOrPayment": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": false,
"x-loket-implementation": "Indien Ulsa.Component.BetalingInhouding de waarde 0 heeft NULL teruggeven.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Ulsa.Component.BetalingInhouding"
},
"value": {
"type": "string",
"example": "Betaling",
"readOnly": false,
"x-loket-db-field": "dbo.ctBetalingInhouding"
}
}
},
"canBeSupplemented": {
"type": "boolean",
"example": false,
"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.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.ComponentAlgemeen.AanvullendMogelijk",
"x-loket-implementation": "1 (ja) = true en 2 (nee) = false"
}
}
},
"value": {
"type": [
"number",
"null"
],
"example": 144,
"description": "Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules).\n",
"readOnly": false
},
"isSupplement": {
"type": [
"boolean",
"null"
],
"example": false,
"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).\n\n* 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.\n\n* 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.\n\nThis boolean can only be set to `true` in components for which `payrollComponent.canBesupplemented = true`.\n",
"readOnly": false,
"x-loket-implementation": "Wanneer de waarde true is, dient de mutatie opgeslagen te worden met attribuut Aanvullend (code 2 in dbo.ctLoontransactie). Wanneer de waarde false is && value == 0 dan dient de mutatie opgeslagen te worden met atttribuut Nul (code 1 in dbo.ctLoontransactie). Wanneer de waarde false is && value != 0 dan dient de mutatie opgeslagen te worden met attribuut Vervangend (code 0 in dbo.ctLoontransactie)."
}
}
}
}
}
},
"smartPasteData": {
"type": "object",
"properties": {
"context": {
"type": "object",
"description": "The context in which the Smart Paste operation is executed.\n",
"readOnly": false,
"properties": {
"employerId": {
"type": "string",
"format": "uuid",
"example": "0d5327ae-0298-49ae-93b7-19cc9d2acb2f",
"description": "The unique identifier of the employer.\n",
"readOnly": false
},
"payrollComponentSet": {
"type": "string",
"format": "uuid",
"example": "ef6d4fec-9118-4dad-9971-3264c6da4ce0",
"description": "A predefined set of payroll components to filter which payroll components are returned.\n",
"readOnly": false
},
"payslipType": {
"type": "integer",
"example": 1,
"description": "The type of payslip (as defined by the Dutch tax authorities).\n",
"readOnly": false
},
"pageNumber": {
"type": [
"integer",
"null"
],
"example": 1,
"description": "The page number of the result which is viewed in payroll period browser when initiating a Smart Paste operation.\n",
"readOnly": false
},
"pageSize": {
"type": [
"integer",
"null"
],
"example": 250,
"description": "The page size of the result which is used in payroll period browser when initiating a Smart Paste operation.\n",
"readOnly": false
},
"orderBy": {
"type": [
"string",
"null"
],
"example": "employee.formattedName,employment.incomeRelationshipNumber",
"description": "The ordering of the result which is used in payroll period browser when initiating a Smart Paste operation.\n",
"readOnly": false
},
"language": {
"type": [
"string",
"null"
],
"example": "Nederlands",
"description": "The language which is set in Loket when initiating a Smart Paste operation.\n",
"readOnly": false
}
}
},
"payrollData": {
"type": "array",
"description": "The current state of the payroll period browser when initiating a Smart Paste operation. This is the results of endpoint GetPayrollPeriodDataByPayrollAdministrationIdAndPayrollPeriodId shown in payroll period browser.\n",
"readOnly": false,
"minItems": 1,
"items": {
"$ref": "#/components/schemas/payrollData-2"
}
},
"clipboard": {
"type": "object",
"description": "The contents of the clipboard to be processed.\n\n__Warning__: `clipboardText` and `clipboardFiles` cannot both be empty.\n",
"readOnly": false,
"properties": {
"clipboardText": {
"type": [
"string",
"null"
],
"example": "Mark heeft 8 uur gewerkt op 2025-10-07. Boek 4 uur op component YRWN G3WERLT voor Susan diezelfde dag.",
"description": "Contents of the clipboard in text format.\n",
"readOnly": false
},
"clipboardFiles": {
"type": [
"array",
"null"
],
"description": "Contents of the clipboard in means of screenshot(s) or copied file(s).\n",
"readOnly": false,
"items": {
"type": "object",
"properties": {
"base64Content": {
"type": "string",
"example": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAIAAAACUFjqAAAAEklEQVR4nGP8z4APMOGVHbHSAEEsAROxCnMTAAAAAElFTkSuQmCC",
"description": "Base64 encoded string of a screenshot or file from the clipboard.\n",
"readOnly": false
},
"mimeType": {
"type": "string",
"example": "image/png",
"description": "MIME type which indicates the type of data contained in the base64 encoded string contained in `base64Content`.\n",
"readOnly": false
}
}
}
}
}
}
}
},
"smartPasteResults": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"context": {
"type": "object",
"description": "The context in which the Smart Paste operation was executed.\n",
"properties": {
"employerId": {
"type": "string",
"format": "uuid",
"example": "0d5327ae-0298-49ae-93b7-19cc9d2acb2f",
"description": "The unique identifier of the employer.\n",
"readOnly": false
},
"payrollAdministrationId": {
"type": "string",
"format": "uuid",
"example": "7ac37672-e04b-48bc-95ce-c6ace069f150",
"description": "The unique identifier of an administration.\n",
"readOnly": false
},
"payrollPeriodId": {
"type": "integer",
"format": "int32",
"example": 202510,
"description": "The unique identifier of the payroll period.\n",
"readOnly": false
},
"payrollComponentSet": {
"type": "string",
"format": "uuid",
"example": "ef6d4fec-9118-4dad-9971-3264c6da4ce0",
"description": "A predefined set of payroll components to filter which payroll components are returned.\n",
"readOnly": false
},
"payslipType": {
"type": "integer",
"example": 1,
"description": "The type of payslip (as defined by the Dutch tax authorities).\n",
"readOnly": false
},
"pageNumber": {
"type": [
"integer",
"null"
],
"example": 1,
"description": "The page number of the result which was viewed in payroll period browser at time of initiation of the Smart Paste operation.\n",
"readOnly": false
},
"pageSize": {
"type": [
"integer",
"null"
],
"example": 250,
"description": "The page size of the result which was used in payroll period browser at time of initiation of the Smart Paste operation.\n",
"readOnly": false
},
"orderBy": {
"type": [
"string",
"null"
],
"example": "employee.formattedName,employment.incomeRelationshipNumber",
"description": "The ordering of the result which was used in payroll period browser at time of initiation of the Smart Paste operation.\n",
"readOnly": false
},
"language": {
"type": [
"string",
"null"
],
"example": "Nederlands",
"description": "The language which was used at time of initiation of the Smart Paste operation.\n",
"readOnly": false
}
}
},
"status": {
"type": "object",
"description": "The status of the Smart Paste operation.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 4,
"description": "The code of the Smart Paste operation status.\n",
"readOnly": false,
"x-loket-implementation": "0 = Unknown, 1 = Requested, 2 = Processing, 3 = Successful, 4 = SuccessfulWithRemarks, 5 = Failed"
},
"value": {
"type": "string",
"example": "SuccessfulWithRemarks",
"description": "The description of the Smart Paste operation status.\n",
"readOnly": false
}
}
},
"remarks": {
"type": "array",
"description": "An array of remarks that were generated processing the Smart Paste operation.\n",
"readOnly": false,
"items": {
"type": "object",
"properties": {
"type": {
"type": "object",
"description": "The type of remark. Possible values are `1 = Info, 2 = Warning, 3 = Error`\n",
"readOnly": false,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The code of the remark type.\n",
"readOnly": false,
"x-loket-implementation": "0 = Unknown, 1 = Info, 2 = Warning, 3 = Error"
},
"value": {
"type": "string",
"example": "Warning",
"description": "The description of the remark type.\n",
"readOnly": false
}
}
},
"message": {
"type": "string",
"example": "Kon component 'YRWN G3WERLT' niet verwerken",
"description": "The message of the remark.\n",
"readOnly": false
}
}
}
},
"results": {
"type": "array",
"description": "Results of the processed Smart Paste operation.\n",
"readOnly": false,
"items": {
"$ref": "#/components/schemas/payrollData-2"
}
}
}
},
"importFile": {
"type": "object",
"properties": {
"mimeType": {
"type": "string",
"enum": [
"text/csv"
],
"description": "The type of file to import. Currently only csv is supported",
"readOnly": false
},
"data": {
"type": "string",
"example": "YQ==",
"description": "base64 encoded file.",
"readOnly": false
}
}
},
"collectiveAction-2": {
"type": "object",
"properties": {
"collectiveActionId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"collectiveActionParentId": {
"type": "string",
"format": "uuid",
"description": "The parentId is used to link the collectiveAction to a parent collectiveAction.\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"employerId": {
"type": "string",
"format": "uuid",
"description": "The employer for which the collectiveAction was submitted.\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"payrollAdministrationId": {
"type": "string",
"format": "uuid",
"description": "The payroll administration for which the collectiveAction was submitted.\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"submittedByUserId": {
"type": "string",
"format": "uuid",
"description": "The user who submitted the collectiveAction.\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"submittedOn": {
"type": "string",
"format": "date-time",
"example": "2023-05-08T15:16:49+02:00",
"description": "Date-time when the collectiveAction was submitted.",
"readOnly": true
},
"status": {
"type": "string",
"enum": [
"Completed",
"NotStarted",
"InProgress"
],
"description": "status of the collectiveAction",
"readOnly": true
},
"type": {
"type": "string",
"enum": [
"Werknemerloket",
"Beloning"
],
"description": "the type of collectiveAction",
"readOnly": true
},
"itemCount": {
"type": "object",
"format": "metadata",
"description": "Summary of the items in the collective action.",
"readOnly": true,
"properties": {
"processedWithError": {
"type": "integer",
"format": "int32",
"example": 10,
"description": "The number of items in the collectiveAction that were processed unsuccessfully and resulted in an error.",
"readOnly": true
},
"processed": {
"type": "integer",
"format": "int32",
"example": 75,
"description": "The number of items in the collectiveAction that were processed successfully without a warning.",
"readOnly": true
},
"processedWithWarning": {
"type": "integer",
"format": "int32",
"example": 15,
"description": "The number of items in the collectiveAction that were processed successfully with a warning.",
"readOnly": true
},
"total": {
"type": "integer",
"format": "int32",
"example": 100,
"description": "The total number of items in the collectiveAction.",
"readOnly": true
}
}
}
}
},
"workflowTrigger": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"description": "A detailed description of the workflow trigger.",
"example": "Adreswijziging",
"maxLength": 256,
"readOnly": true
},
"category": {
"type": "string",
"description": "The category of the workflow trigger.",
"example": "WNL",
"maxLength": 256,
"readOnly": true
},
"workflowTemplate": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates what workflow template will be used to initiate a workflow when the trigger takes place.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
}
}
}
}
},
"assignee": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"assigneeType": {
"type": "string",
"enum": [
"UserType",
"UserResponsibility"
],
"readOnly": false
},
"description": {
"type": [
"string",
"null"
],
"readOnly": true
},
"numberOfLinkedUsers": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 3,
"description": "Number of users for the given assigneeType with access to the employer",
"readOnly": true
}
}
},
"task": {
"type": "object",
"properties": {
"taskId": {
"type": "integer",
"readOnly": false,
"minimum": 1
},
"taskType": {
"type": "string",
"enum": [
"Notification",
"Approval",
"Task"
],
"readOnly": false
},
"description": {
"type": [
"string",
"null"
],
"readOnly": false,
"maxLength": 1000
},
"sendEmail": {
"type": [
"boolean",
"null"
],
"readOnly": false
},
"assignees": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/assignee"
},
"readOnly": false
}
}
},
"workflowTemplate": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"userInstruction": {
"type": [
"string",
"null"
],
"readOnly": false,
"maxLength": 1000
},
"tasks": {
"type": "array",
"maxItems": 6,
"items": {
"$ref": "#/components/schemas/task"
}
}
}
},
"userBasicNotNullable": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"initials": {
"type": "string",
"example": "I",
"description": "The initials of the user",
"maxLength": 6,
"readOnly": true,
"x-loket-db-field": "Loket.Gebruiker.Voorletters"
},
"prefix": {
"type": [
"string",
"null"
],
"example": "de",
"description": "The prefix of the user",
"maxLength": 10,
"readOnly": true,
"x-loket-db-field": "Loket.Gebruiker.Voorvoegsel"
},
"lastName": {
"type": "string",
"example": "Jong",
"description": "The last name of the user",
"maxLength": 25,
"readOnly": true,
"x-loket-db-field": "Loket.Gebruiker.Achternaam"
},
"formattedName": {
"type": "string",
"example": "Jong, I",
"description": "preformated user name for displaying. \\\\\", \\\"\\\\\" \\\"\\",
"readOnly": true
}
}
},
"workflowTriggerMapping": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"trigger": {
"type": "object",
"format": "metadata",
"description": "Indicates the workflow trigger to be configured.\n\n`trigger` is a metadata field within the employer context. Possible values can be managed by the user. ",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"description": {
"type": "string",
"example": "Address change for employee",
"maxLength": 256,
"readOnly": true
}
}
},
"workflowTemplate": {
"type": "object",
"format": "metadata",
"description": "Indicates what workflow template will be used to initiate a workflow when the trigger takes place.\n\n`workflowTemplate` is a metadata field within the employer context. Possible values can be managed by the user. ",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"description": {
"type": "string",
"example": "Approval by employer",
"maxLength": 256,
"readOnly": true
}
}
},
"createdOn": {
"type": "string",
"format": "date-time",
"example": "2019-11-23T11:14:06Z",
"readOnly": true
},
"createdBy": {
"$ref": "#/components/schemas/userBasicNotNullable"
},
"lastModifiedOn": {
"type": "string",
"format": "date-time",
"example": "2019-11-23T11:14:06Z",
"readOnly": true
},
"lastModifiedBy": {
"$ref": "#/components/schemas/userBasicNotNullable"
}
}
},
"changeAddressRequest": {
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "Voordijk",
"description": "Streetname of the address",
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Straatnaam"
},
"city": {
"type": "string",
"example": "Leiden",
"maxLength": 24,
"description": "City of the address",
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Plaatsnaam"
},
"houseNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"description": "House number of the address",
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Huisnummer"
},
"houseNumberAddition": {
"type": [
"string",
"null"
],
"example": "D",
"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.",
"maxLength": 4,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Huisnummertoevoeging"
},
"postalCode": {
"type": "string",
"example": "1234 AA",
"description": "The postal code of the address, only nullable if country is not The Netherlands (NL).",
"minLength": 1,
"maxLength": 9,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Postcode",
"x-loket-implementation": "Indien land = NL moet de postcode aan de regex van NL voldoen (9999 aa)"
},
"country": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the country. Possible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Land"
},
"value": {
"type": "string",
"example": "Netherlands",
"description": "The name of the country",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.Omschrijving"
},
"isoCode": {
"type": "string",
"example": "NL",
"description": "The ISO 3166-1 alpha-2 value for the country",
"maxLength": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.IsoCode"
}
}
}
}
},
"comment": {
"type": [
"string",
"null"
],
"example": "We move house September 26th",
"description": "An extra comment for the change request",
"minLength": 1,
"maxLength": 1000,
"readOnly": false
}
}
},
"changeAddressResponse": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
},
"changeContactInformationRequest": {
"type": "object",
"properties": {
"contactInformation": {
"type": "object",
"properties": {
"phoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 13-1234567",
"description": "The phone number of the employee.",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Telefoon"
},
"mobilePhoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 6-1231456",
"description": "The mobile phone number of the employee.",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Mobiel"
},
"faxNumber": {
"type": [
"string",
"null"
],
"example": "+31 13-1234561",
"description": "The fax number of the employee",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Fax"
},
"emailAddress": {
"type": [
"string",
"null"
],
"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])))$",
"example": "info@loket.nl",
"description": "The e-mail address of the employee. This field is required when the product Employee Self Serve is used.",
"maxLength": 255,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Email"
}
}
},
"comment": {
"type": [
"string",
"null"
],
"example": "Changed my mobile phone number.",
"description": "An extra comment for the change request",
"minLength": 1,
"maxLength": 1000,
"readOnly": false
}
}
},
"changeContactInformationResponse": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
},
"changeAddressRequest-2": {
"type": "object",
"properties": {
"effectiveFromDate": {
"type": "string",
"format": "date",
"example": "2024-09-31",
"description": "The effective from date refers to the specific date on which the change outlined in the request should become operational",
"readOnly": false
},
"address": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "Voordijk",
"description": "Streetname of the address",
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Straatnaam"
},
"city": {
"type": "string",
"example": "Leiden",
"maxLength": 24,
"description": "City of the address",
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Plaatsnaam"
},
"houseNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"description": "House number of the address",
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Huisnummer"
},
"houseNumberAddition": {
"type": [
"string",
"null"
],
"example": "D",
"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.",
"maxLength": 4,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Huisnummertoevoeging"
},
"postalCode": {
"type": "string",
"example": "1234 AA",
"description": "The postal code of the address, only nullable if country is not The Netherlands (NL).",
"minLength": 1,
"maxLength": 9,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Postcode",
"x-loket-implementation": "Indien land = NL moet de postcode aan de regex van NL voldoen (9999 aa)"
},
"country": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the country. Possible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Land"
},
"value": {
"type": "string",
"example": "Netherlands",
"description": "The name of the country",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.Omschrijving"
},
"isoCode": {
"type": "string",
"example": "NL",
"description": "The ISO 3166-1 alpha-2 value for the country",
"maxLength": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.IsoCode"
}
}
}
}
},
"comment": {
"type": [
"string",
"null"
],
"example": "We move house September 26th",
"description": "An extra comment for the change request",
"minLength": 1,
"maxLength": 1000,
"readOnly": false
}
}
},
"changeContactInformationRequest-2": {
"type": "object",
"properties": {
"phoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 13-1234567",
"description": "The phone number of the employee.",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Telefoon"
},
"mobilePhoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 6-1231456",
"description": "The mobile phone number of the employee.",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Mobiel"
},
"emailAddress": {
"type": [
"string",
"null"
],
"example": "info@loket.nl",
"description": "The e-mail address of the employee. Only one email address is allowed.",
"maxLength": 255,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Email"
},
"comment": {
"type": [
"string",
"null"
],
"example": "We move house September 26th",
"description": "An extra comment for the change request",
"minLength": 1,
"maxLength": 1000,
"readOnly": false
}
}
},
"howToFormatLastName": {
"type": "object",
"format": "metadata",
"readOnly": false,
"description": "Indicates how the system will format the last name.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.(Persoon/Partner).GebruikAchternaam"
},
"value": {
"type": "string",
"example": "last name + last name partner",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctGebruikAchternaam.Omschrijving"
}
}
},
"changePersonalInformationRequest": {
"type": "object",
"properties": {
"effectiveFromDate": {
"type": "string",
"format": "date",
"example": "2024-09-31",
"description": "The effective from date refers to the specific date on which the change outlined in the request should becomes operational",
"readOnly": false
},
"civilStatus": {
"type": "object",
"format": "metadata",
"description": "The civil/marital status of the employee\n",
"x-loket-implementation": "0 = null",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.BurgelijkeStaat"
},
"value": {
"type": "string",
"example": "Maried",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBurgelijkeStaat.Omschrijving"
}
}
},
"howToFormatLastName": {
"$ref": "#/components/schemas/howToFormatLastName"
},
"lastNamePartner": {
"type": [
"string",
"null"
],
"example": "Wiel",
"description": "The last name of the employee's partner.",
"minLength": 1,
"maxLength": 25,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.PartnerAchternaam"
},
"prefixPartner": {
"type": [
"string",
"null"
],
"example": "van de",
"description": "The prefix to the last name of the employee's partner.",
"maxLength": 10,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.PartnerVoorvoegsel"
},
"comment": {
"type": [
"string",
"null"
],
"example": "I got married !!!!!!!",
"description": "An extra comment for the change request",
"minLength": 1,
"maxLength": 1000,
"readOnly": false
}
}
},
"changePersonalInformationResponse": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
},
"startDate-2": {
"type": [
"string",
"null"
],
"format": "date",
"example": "1995-05-21",
"description": "startdate",
"readOnly": false,
"x-loket-db-field": "Loket.partner.DatumIngang"
},
"endDate-2": {
"type": [
"string",
"null"
],
"format": "date",
"example": "1995-05-21",
"description": "end date",
"readOnly": false,
"x-loket-db-field": "Loket.partner.DatumEinde"
},
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name, given name, forename or Christian name as part of a persons personal name.\n",
"minLength": 1,
"maxLength": 28,
"readOnly": false,
"x-loket-db-field": "Loket.(Persoon/Partner/Kind).Roepnaam"
},
"lastName": {
"type": "string",
"example": "Bergen",
"description": "The last name, family name or surname as part of a persons personal name.\n",
"minLength": 1,
"maxLength": 25,
"readOnly": false,
"x-loket-db-field": "Loket.(Persoon/Partner/Kind).Achternaam"
},
"prefix": {
"type": [
"string",
"null"
],
"example": "van",
"description": "The prefix to the last name\n",
"minLength": 1,
"maxLength": 10,
"readOnly": false,
"x-loket-db-field": "Loket.(Persoon/Partner/Kind).Voorvoegsel"
},
"initials": {
"type": [
"string",
"null"
],
"example": "S.L.",
"description": "The initials\n",
"minLength": 1,
"maxLength": 6,
"readOnly": false,
"x-loket-db-field": "Loket.Partner.Voorletters"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1995-05-21",
"description": "The date of birth\n",
"readOnly": false,
"x-loket-db-field": "Loket.(Persoon/Partner/Kind).Geboortedatum"
},
"placeOfBirth": {
"type": [
"string",
"null"
],
"example": "Amsterdam",
"description": "The place of birth\n",
"minLength": 1,
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "Loket.(Persoon/Partner).Geboorteplaats"
},
"dateOfDeath": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The date of death\n",
"readOnly": false,
"x-loket-db-field": "Loket.(Persoon/Partner/Kind).Overlijdensdatum"
},
"howToFormatLastName-2": {
"type": "object",
"format": "metadata",
"readOnly": false,
"description": "Indicates how the system will format the last name.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.(Persoon/Partner).GebruikAchternaam"
},
"value": {
"type": "string",
"example": "last name + last name partner",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctGebruikAchternaamPartner.Omschrijving"
}
}
},
"title": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": false,
"description": "The title to be used (if any).\n",
"x-loket-implementation": "Indien NULL een 0 in de database opslaan en visaversa",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.(Persoon/Partner).Titulatuur"
},
"value": {
"type": "string",
"example": "e.g. Msc, PHD or Baron",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctTitulatuur.Omschrijving"
}
}
},
"gender": {
"type": "object",
"format": "metadata",
"description": "The gender\n",
"readOnly": false,
"x-loket-implementation": "Let op: Bij Loket.Kind is het in GUI 2 mogelijk om geslacht op onbekend in te stellen. Met de introductie van de API willen we dat niet meer mogelijk maken. Het kan echter wel zijn dat de API een kind met geslacht onbekend uit de database krijgt hier moet rekening mee gehouden worden (lieft wel tonen maar niet kunnen wijzigen zonder geslacht te selecteren).",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.(Persoon/Partner/Kind).Geslacht"
},
"value": {
"type": "string",
"example": "female",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctGeslacht.Omschrijving"
}
}
},
"waoClassification": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The occupational disability classification in the form of a percentage range.",
"readOnly": false,
"x-loket-implementation": "In het geval dat WAOKlasse 0 is, dit veld NULL maken",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The key of the occupational disability classification. Possible values can be acquired via the metadata endpoint.\n",
"readOnly": false,
"x-loket-db-field": "Loket.Partner.WAOKlasse"
},
"value": {
"type": "string",
"example": "15 - 24",
"description": "Description of the occupational disability classification.\n",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctWAOKlasse",
"x-loket-implementation": "De omschrijving van het record met code 1 bevat een leading space. Deze willen we eruit filteren"
}
}
},
"create": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"create"
]
},
"startDate": {
"$ref": "#/components/schemas/startDate-2"
},
"endDate": {
"$ref": "#/components/schemas/endDate-2"
},
"firstName": {
"$ref": "#/components/schemas/firstName"
},
"lastName": {
"$ref": "#/components/schemas/lastName"
},
"prefix": {
"$ref": "#/components/schemas/prefix"
},
"initials": {
"$ref": "#/components/schemas/initials"
},
"dateOfBirth": {
"$ref": "#/components/schemas/dateOfBirth"
},
"placeOfBirth": {
"$ref": "#/components/schemas/placeOfBirth"
},
"dateOfDeath": {
"$ref": "#/components/schemas/dateOfDeath"
},
"howToFormatLastName": {
"$ref": "#/components/schemas/howToFormatLastName-2"
},
"title": {
"$ref": "#/components/schemas/title"
},
"gender": {
"$ref": "#/components/schemas/gender"
},
"waoClassification": {
"$ref": "#/components/schemas/waoClassification"
},
"comment": {
"type": [
"string",
"null"
],
"example": "We move house September 26th",
"description": "An extra comment for the change request",
"minLength": 1,
"readOnly": false
}
}
},
"update": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"update"
]
},
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"$ref": "#/components/schemas/startDate-2"
},
"endDate": {
"$ref": "#/components/schemas/endDate-2"
},
"firstName": {
"$ref": "#/components/schemas/firstName"
},
"lastName": {
"$ref": "#/components/schemas/lastName"
},
"prefix": {
"$ref": "#/components/schemas/prefix"
},
"initials": {
"$ref": "#/components/schemas/initials"
},
"dateOfBirth": {
"$ref": "#/components/schemas/dateOfBirth"
},
"placeOfBirth": {
"$ref": "#/components/schemas/placeOfBirth"
},
"dateOfDeath": {
"$ref": "#/components/schemas/dateOfDeath"
},
"howToFormatLastName": {
"$ref": "#/components/schemas/howToFormatLastName-2"
},
"title": {
"$ref": "#/components/schemas/title"
},
"gender": {
"$ref": "#/components/schemas/gender"
},
"waoClassification": {
"$ref": "#/components/schemas/waoClassification"
},
"comment": {
"type": [
"string",
"null"
],
"example": "We move house September 26th",
"description": "An extra comment for the change request",
"minLength": 1,
"readOnly": false
}
}
},
"delete": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"delete"
]
},
"id": {
"$ref": "#/components/schemas/id"
},
"comment": {
"type": [
"string",
"null"
],
"example": "We move house September 26th",
"description": "An extra comment for the change request",
"minLength": 1,
"readOnly": false
}
}
},
"response": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
},
"name-2": {
"type": "string",
"example": "Johanna Bakker",
"description": "Name of the contact",
"maxLength": 70,
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Naam"
},
"description-2": {
"type": "string",
"example": "Moeder",
"description": "Describes the relationship of the contact to the employee",
"maxLength": 50,
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Kenmerk"
},
"phoneNumber": {
"type": [
"string",
"null"
],
"example": "013-12345678",
"description": "The phone number of the contact",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Telefoon"
},
"address-2": {
"type": [
"object",
"null"
],
"x-loket-comment": "Hier wordt niet gebruik gemaakt van de address definitie in SharedComponents omdat PersoonContact geen provincie en locatie heeft.",
"properties": {
"street": {
"type": "string",
"example": "Voordijk",
"description": "Streetname of the address",
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Straatnaam"
},
"city": {
"type": "string",
"example": "Leiden",
"maxLength": 24,
"description": "City of the address",
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Plaatsnaam"
},
"houseNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"description": "House number of the address",
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Huisnummer"
},
"houseNumberAddition": {
"type": [
"string",
"null"
],
"example": "D",
"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.",
"maxLength": 4,
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Huisnummertoevoeging"
},
"postalCode": {
"type": [
"string",
"null"
],
"example": "1234 AA",
"description": "The postal code of the address",
"maxLength": 9,
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Postcode"
},
"country": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the country. Possible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Land"
},
"value": {
"type": "string",
"example": "Netherlands",
"description": "The name of the country",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.Omschrijving"
},
"isoCode": {
"type": "string",
"example": "NL",
"description": "The ISO 3166-1 alpha-2 value for the country",
"maxLength": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.IsoCode"
}
}
}
}
},
"particularities": {
"type": [
"string",
"null"
],
"example": "Genoemd adres is een priveadres",
"description": "Extra information about the contact",
"maxLength": 4000,
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Bijzonderheden"
},
"create-2": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"create"
]
},
"name": {
"$ref": "#/components/schemas/name-2"
},
"description": {
"$ref": "#/components/schemas/description-2"
},
"phoneNumber": {
"$ref": "#/components/schemas/phoneNumber"
},
"address": {
"$ref": "#/components/schemas/address-2"
},
"particularities": {
"$ref": "#/components/schemas/particularities"
},
"comment": {
"type": [
"string",
"null"
],
"example": "Nieuw doctor",
"description": "An extra comment for the change request",
"minLength": 1,
"readOnly": false
}
}
},
"update-2": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"update"
]
},
"id": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"name": {
"$ref": "#/components/schemas/name-2"
},
"description": {
"$ref": "#/components/schemas/description-2"
},
"phoneNumber": {
"$ref": "#/components/schemas/phoneNumber"
},
"address": {
"$ref": "#/components/schemas/address-2"
},
"particularities": {
"$ref": "#/components/schemas/particularities"
},
"comment": {
"type": [
"string",
"null"
],
"example": "My mother moved",
"description": "An extra comment for the change request",
"minLength": 1,
"readOnly": false
}
}
},
"delete-2": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"delete"
]
},
"id": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"comment": {
"type": [
"string",
"null"
],
"example": "Switched doctor",
"description": "An extra comment for the change request",
"minLength": 1,
"readOnly": false
}
}
},
"payrollComponent": {
"type": "object",
"format": "metadata",
"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. \n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 11,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know it by heart.\n",
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerMutatie.Component"
},
"description": {
"type": "string",
"example": "UREN TVT 130%",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
},
"deviatingDescription": {
"type": [
"string",
"null"
],
"example": "Uren tijd voor tijd 130%",
"description": "A longer and more user-friendly description of the payroll component.\n",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Ulsa.ComponentNaamAfwijkend (database view)"
},
"deductionOrPayment": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"x-loket-implementation": "Indien Ulsa.Component.BetalingInhouding de waarde 0 heeft NULL teruggeven.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.BetalingInhouding"
},
"value": {
"type": "string",
"example": "Betaling",
"readOnly": true,
"x-loket-db-field": "dbo.ctBetalingInhouding"
}
}
},
"routeType": {
"type": [
"object",
"null"
],
"readOnly": true,
"format": "metadata",
"description": "The route type determines how the route is calculate.\n\n__Note:__ NULL means route calculation is disabled",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Snelste",
"readOnly": true
}
}
}
}
},
"calculatedDistanceByRoutingService": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 8,
"description": "The value calulated by the routing service",
"minimum": 0.01,
"maximum": 99999999.99,
"readOnly": false
},
"numberOfUnits": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 8,
"description": "The number of units requested",
"minimum": 0.01,
"maximum": 99999999.99,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerMutatie.AantalEenheden"
},
"numberOfUnitsByAnalysis": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 8,
"description": "The number of units scanned by the azure document intelligence analysis (uses the total value from PostAnalyzeReceiptByEmploymentId response)",
"minimum": 0,
"maximum": 99999999.99
},
"declarationDate": {
"type": "string",
"format": "date",
"example": "2017-11-01",
"description": "The date to which the declaration is applicable. As requested by the employee.",
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerMutatie.Datum"
},
"reasonForDeviatingFromCalculatedDistance": {
"type": [
"string",
"null"
],
"description": "The reason why the employee deviated form the calculated distance.",
"example": "There were some ongoing road works i had to get around",
"maxLength": 1000,
"readOnly": false
},
"route": {
"type": [
"array",
"null"
],
"description": "If applicable contains the addresses of stops used to calculate the route. The order of the items in the array is equal to the order of the route taken.",
"items": {
"properties": {
"pointOfInterest": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"type": [
"string",
"null"
],
"example": "Van Spaendonck Groep",
"description": "The name of the point of interest",
"maxLength": 1000,
"readOnly": false
}
}
},
"address": {
"type": "object",
"properties": {
"freeformAddress": {
"type": "string",
"description": "description of the address",
"example": "Reitseplein 1, 5037 AA Tilburg",
"maxLength": 1000,
"readOnly": false
},
"countryCode": {
"type": [
"string",
"null"
],
"example": "NL",
"description": "isocode of the country",
"minLength": 2,
"maxLength": 2,
"readOnly": false
}
}
},
"position": {
"type": "object",
"properties": {
"latitude": {
"description": "latitude for the address",
"example": 51.585996,
"pattern": "^(-?\\d{1,2})(\\.\\d{1,6})?$",
"type": "number",
"format": "double",
"minimum": -90,
"maximum": 90
},
"longitude": {
"description": "longitude for the address",
"example": 5.585996,
"pattern": "^(-?\\d{1,3})(\\.\\d{1,6})?$",
"type": "number",
"format": "double",
"minimum": -180,
"maximum": 180
}
}
}
}
}
},
"declarationRequest": {
"type": "object",
"properties": {
"payrollComponent": {
"$ref": "#/components/schemas/payrollComponent"
},
"calculatedDistanceByRoutingService": {
"$ref": "#/components/schemas/calculatedDistanceByRoutingService"
},
"numberOfUnits": {
"$ref": "#/components/schemas/numberOfUnits"
},
"numberOfUnitsByAnalysis": {
"$ref": "#/components/schemas/numberOfUnitsByAnalysis"
},
"declarationDate": {
"$ref": "#/components/schemas/declarationDate"
},
"reasonForDeviatingFromCalculatedDistance": {
"$ref": "#/components/schemas/reasonForDeviatingFromCalculatedDistance"
},
"route": {
"$ref": "#/components/schemas/route"
},
"comment": {
"type": [
"string",
"null"
],
"example": "Had to park in a garage",
"description": "An extra comment for the declaration request",
"minLength": 1,
"maxLength": 1000,
"readOnly": false
}
}
},
"declarationResponse": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
},
"changeIbanRequest": {
"type": "object",
"properties": {
"iban": {
"type": "string",
"example": "NL91ABNA0417164300",
"description": "The new IBAN for the employment",
"minLength": 15,
"maxLength": 34,
"readOnly": false
},
"comment": {
"type": [
"string",
"null"
],
"example": "I switched bank",
"description": "An extra comment for the change IBAN request",
"minLength": 1,
"maxLength": 1000,
"readOnly": false
}
}
},
"ibanResponse": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
},
"numberOfUnits-2": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,2})?$",
"example": 8,
"description": "The number of leave units requested",
"minimum": 0,
"maximum": 999.99,
"readOnly": false,
"x-loket-db-field": "Loket.Verlofaanvraag.AantalEenheden"
},
"unitType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "If known indicates what the unit type (hours or days) is for `numberOfUnits`. Otherwise the field will be null.",
"readOnly": true,
"x-loket-implementation": "Een \"gecalculeerd\" veld (LOK-3745) * Voor een dienstverband met 1 of meerdere gekoppelde verlofregelingen met allemaal dezelfde verlofeenheid, wordt die verlofeenheid getoond in de applicatie * Voor een dienstverband met meerdere gekoppelde verlofregelingen met _verschillende_ verlofeenheden (een vreemde inrichting), wordt er _geen_ verlofeenheid getoond in de applicatie * Voor een dienstverband _zonder_ gekoppelde verlofregelingen, wordt er _geen_ verlofeenheid getoond in de applicatie",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the unit type\n",
"readOnly": true,
"x-loket-db-field": "dbo.ctVerlofEenheid.code (op basis van de logica voor het hele object)"
},
"value": {
"type": "string",
"example": "Uren",
"description": "The description for the unit type\n",
"readOnly": true,
"x-loket-db-field": "dbo.ctVerlofEenheid.code"
}
}
},
"isAccrual": {
"type": "boolean",
"example": false,
"description": "Indicates whether the request is for accrual of leave.\n- false will result in a reduction of the employee's leave entitlement\n- true will result in an increase of the employee's leave entitlement\n",
"readOnly": false,
"default": false,
"x-loket-db-field": "Loket.Verlofaanvraag.Factor",
"x-loket-implementation": "In de database is dit een integer veld met de waarde 1 of -1. In de API geven we true terug in het geval van waarde 1 en geven we false terug in het geval van waarde -1."
},
"startDate-3": {
"type": "string",
"format": "date",
"example": "2017-11-01",
"description": "The start date of the leave requested",
"readOnly": false,
"x-loket-db-field": "Loket.Verlofaanvraag.DatumIngang"
},
"endDate-3": {
"type": "string",
"format": "date",
"example": "2017-11-01",
"description": "The end date of the leave requested (last day of the leave)",
"readOnly": false,
"x-loket-db-field": "Loket.Verlofaanvraag.DatumEinde"
},
"leaveType": {
"type": "object",
"format": "metadata",
"description": "The type of leave requested by the employee\n\n`leaveType` is a metadata field within the employer context. Possible values can be managed by the user.",
"x-loket-implementation": "Let op dat het mogelijk is om afwijkingen op werkgever niveau op te geven voor de CT waardes",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Verlofaanvraag.Soort"
},
"value": {
"type": "string",
"example": "Verlof (bovenwettelijk)",
"readOnly": true,
"x-loket-db-field": "dbo.ctVerlof.Omschrijving"
}
}
},
"leaveRequestStatus": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "The current status of the leave request\n\nThe leave request status is changed by using the PATCH endpoint (not the PUT).\n\nThe following transitions are possible\n* leaveRequestStatus = (1)submitted -> accept, reject or revoke(by employee)\n* leaveRequestStatus = (9)accepted -> revoke or reopen(by employee)\n* leaveRequestStatus = (3)rejected -> submitted\n* leaveRequestStatus = (10) accepted with revoke request -> accept of reject",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 9,
"readOnly": true,
"x-loket-db-field": "Loket.Verlofaanvraag.Status"
},
"value": {
"type": "string",
"example": "Geaccepteerd",
"readOnly": true,
"x-loket-db-field": "dbo.ctVerlofaanvraagStatus.Omschrijving"
}
}
},
"submittedOn": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time the leave request was submitted",
"readOnly": true,
"x-loket-db-field": "Loket.Verlofaanvraag.DatumAanvraag"
},
"employeeBasic": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 156,
"description": "The employee number to uniquely identify a employee within a employer.",
"readOnly": true,
"x-loket-db-field": "Loket.Persoon."
},
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name of the employee",
"maxLength": 28,
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.Roepnaam"
},
"initials": {
"type": "string",
"example": "S.L.",
"description": "The initials of the employee",
"maxLength": 6,
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.Voorletters"
},
"prefix": {
"type": [
"string",
"null"
],
"example": "van",
"description": "The prefix of the employee",
"maxLength": 10,
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.Voorvoegsel"
},
"lastName": {
"type": "string",
"example": "Bergen",
"description": "The last name of the employee",
"maxLength": 25,
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.Achternaam"
},
"prefixPartner": {
"type": [
"string",
"null"
],
"example": "van de",
"description": "The prefix of the partner of the employee",
"maxLength": 10,
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.PartnerVoorvoegsel"
},
"lastNamePartner": {
"type": [
"string",
"null"
],
"example": "Wiel",
"description": "The last name of the partner of the employee",
"maxLength": 25,
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.PartnerAchternaam"
},
"formattedName": {
"type": "string",
"example": "Wiel - van Bergen S.L. van de",
"description": "Formatted name of the employee based on the value of `howToFormatLastName`",
"maxLength": 82,
"readOnly": true,
"x-loket-implementation": "Dit veld is een samenvoegsel van de losse naam elementen. De logica voor het opbouwen van de naam is gelijk aan de logica in Loket.vwVolledigeNaam"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1995-05-21",
"description": "The date of birth\n",
"readOnly": true
},
"photo": {
"type": [
"string",
"null"
],
"format": "url",
"example": "https://api.loket.nl/v2/v2/providers/employers/employees/{employeeId}/photo/{version}",
"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.",
"readOnly": true
}
}
},
"handledTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The date and time the leave request was handled",
"readOnly": true,
"x-loket-db-field": "Loket.Verlofaanvraag.DatumBehandeling"
},
"handledBy": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"initials": {
"type": "string",
"example": "ABC",
"description": "The initials of the user",
"maxLength": 6,
"readOnly": true,
"x-loket-db-field": "Loket.Gebruiker.Voorletters"
},
"prefix": {
"type": [
"string",
"null"
],
"example": "de",
"description": "The prefix of the user",
"maxLength": 10,
"readOnly": true,
"x-loket-db-field": "Loket.Gebruiker.Voorvoegsel"
},
"lastName": {
"type": "string",
"example": "Jong",
"description": "The last name of the user",
"maxLength": 25,
"readOnly": true,
"x-loket-db-field": "Loket.Gebruiker.Achternaam"
},
"formattedName": {
"type": "string",
"example": "Jong, I",
"description": "preformated user name for displaying. \", \"\" \"",
"readOnly": true
}
}
},
"commentEmployeePost": {
"type": [
"string",
"null"
],
"description": "The comment left by the employee",
"example": "Vakantie naar Spanje",
"maxLength": 4000,
"readOnly": false,
"x-loket-db-field": "Loket.Verlofaanvraag.OpmerkingAanvrager",
"x-loket-implementation": "Een lege string in de database wordt in de API teruggegeven als NULL."
},
"commentHandlerPost": {
"type": [
"string",
"null"
],
"description": "The comment left by the person handling the leave request",
"example": "Fijne vakantie!",
"maxLength": 4000,
"readOnly": true,
"x-loket-db-field": "Loket.Verlofaanvraag.OpmerkingBehandelaar",
"x-loket-implementation": "Een lege string in de database wordt in de API teruggegeven als NULL."
},
"currentlyAvailableUnits": {
"type": "number",
"format": "double",
"example": 140,
"description": "The number of leave units (of the leaveType for this leave request) available to the employment.\nThis value can be negative.",
"readOnly": true
},
"startedViaWorkflow": {
"type": "boolean",
"description": "Indicates whether the leave request was started via a workflow",
"example": true,
"readOnly": true
},
"leaveRequest": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"numberOfUnits": {
"$ref": "#/components/schemas/numberOfUnits-2"
},
"unitType": {
"$ref": "#/components/schemas/unitType"
},
"isAccrual": {
"$ref": "#/components/schemas/isAccrual"
},
"startDate": {
"$ref": "#/components/schemas/startDate-3"
},
"endDate": {
"$ref": "#/components/schemas/endDate-3"
},
"leaveType": {
"$ref": "#/components/schemas/leaveType"
},
"leaveRequestStatus": {
"$ref": "#/components/schemas/leaveRequestStatus"
},
"submittedOn": {
"$ref": "#/components/schemas/submittedOn"
},
"submittedBy": {
"$ref": "#/components/schemas/employeeBasic"
},
"handledTime": {
"$ref": "#/components/schemas/handledTime"
},
"handledBy": {
"$ref": "#/components/schemas/handledBy"
},
"commentEmployee": {
"$ref": "#/components/schemas/commentEmployeePost"
},
"commentHandler": {
"$ref": "#/components/schemas/commentHandlerPost"
},
"currentlyAvailableUnits": {
"$ref": "#/components/schemas/currentlyAvailableUnits"
},
"startedViaWorkflow": {
"$ref": "#/components/schemas/startedViaWorkflow"
}
}
},
"withdrawLeaveRequest": {
"type": "object",
"properties": {
"comment": {
"type": [
"string",
"null"
],
"description": "The comment left by the employee",
"example": "Vergissing, ik wil mijn verlofaanvraag intrekken.",
"maxLength": 4000,
"readOnly": false
}
}
},
"employmentDocumentRequestRequest": {
"type": "object",
"properties": {
"documentType": {
"type": "string",
"example": "employerStatement",
"description": "The documentType for now only exists out of one document type: employerStatement",
"readOnly": false
},
"comment": {
"type": [
"string",
"null"
],
"example": "Respond quickly please, I need the document by tomorrow afternoon.",
"description": "An extra comment for the change request",
"minLength": 1,
"maxLength": 1000,
"readOnly": false
}
}
},
"employmentDocumentRequestResponse": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
},
"contractExtensionRequest": {
"type": "object",
"properties": {
"commissionUntilDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2019-01-01",
"description": "The date on which the employment will end. NL: AanstellingTot",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.AanstellingTot"
},
"startDateContractOfIndefiniteDuration": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-05-08",
"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.",
"readOnly": false
},
"employmentDurationType": {
"type": "object",
"format": "metadata",
"description": "A selection of pre defined durations for the employment.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.SoortDienstverband"
},
"value": {
"type": "string",
"example": "Contract of indefinite duration",
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortDienstverband.Omschrijving"
}
}
},
"comment": {
"type": [
"string",
"null"
],
"example": "We move house September 26th",
"description": "An extra comment for the change request",
"minLength": 1,
"maxLength": 1000,
"readOnly": false
}
}
},
"contractExtensionResponse": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
},
"endDate-4": {
"type": "string",
"format": "date",
"example": "2018-10-23",
"description": "The date on which the employment ends (=last day of the employment).\n",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.DatumUitDienst"
},
"endOfEmploymentReason": {
"type": "object",
"format": "metadata",
"description": "The reason for the end of the employment.\n\n__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. \n\nPlease set this field to 8 (Other) unless one of the following integrations is used for this employment\n * UPA-pensioenaangifte\n * Cordares\n * APG-pensioenaangifte\n * Achmea",
"readOnly": false,
"x-loket-implementation": "Indien de waarde 0 (n.v.t) is het element NULL maken.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the reason for the end of the employment.",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.RedenEindeDienstverband"
},
"value": {
"type": "string",
"example": "VUT",
"description": "The description of the reason for the end of the employment.",
"readOnly": true,
"x-loket-db-field": "dbo.ctRedenEindeDienstverband.Omschrijving"
}
}
},
"endOfEmploymentDueToIllness": {
"type": "boolean",
"example": false,
"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.\n",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.ZiekUitDienst",
"x-loket-implementation": "In de database is dit een non-nullable veld. In de API vertalen we dit alsvolgt: 0 = null, 1 = true, 2 = false. Alleen in te vullen indien endDate gevuld is. "
},
"createMdvEntry": {
"type": "boolean",
"example": false,
"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`.\n\nNext 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).\n",
"readOnly": false,
"x-loket-db-field": "wordt niet opgeslagen in DB, echter er wordt een record gecreeerd in MdvMelding tabel"
},
"endOfEmploymentReasonTaxAuthorities": {
"type": "object",
"format": "metadata",
"description": "The reason for the end of the employment as specified by the Dutch Tax authorties.\n\n__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.\n",
"readOnly": false,
"x-loket-implementation": "Indien de waarde 0 (n.v.t) is het element NULL maken.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the reason for the end of the employment.",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.RedenEindeDienstverbandAangifte"
},
"value": {
"type": "string",
"example": "Opzegging door de werkgever binnen de proeftijd.",
"description": "The description of the reason for the end of the employment.",
"readOnly": true,
"x-loket-db-field": "dbo.ctRedenEindeDienstverbandAangifte.Omschrijving"
}
}
},
"commentWorkflow": {
"type": [
"string",
"null"
],
"example": "We move house September 26th",
"description": "An extra comment for the change request",
"minLength": 1,
"maxLength": 1000,
"readOnly": false
},
"terminateEmploymentRequest": {
"type": "object",
"properties": {
"endDate": {
"$ref": "#/components/schemas/endDate-4"
},
"endOfEmploymentReason": {
"$ref": "#/components/schemas/endOfEmploymentReason"
},
"endOfEmploymentDueToIllness": {
"$ref": "#/components/schemas/endOfEmploymentDueToIllness"
},
"createMdvEntry": {
"$ref": "#/components/schemas/createMdvEntry"
},
"endOfEmploymentReasonTaxAuthorities": {
"$ref": "#/components/schemas/endOfEmploymentReasonTaxAuthorities"
},
"comment": {
"$ref": "#/components/schemas/commentWorkflow"
}
}
},
"terminateEmploymentResponse": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
},
"attachmentPostObject": {
"properties": {
"file": {
"type": "string",
"example": "YQ==",
"description": "base64 encoded document file.",
"readOnly": false
},
"filename": {
"type": "string",
"description": "The name of the file. Qwoater: Filename\n",
"example": "BowlsJohn.pdf",
"minLength": 1,
"maxLength": 250,
"readOnly": false
}
}
},
"workflowIds": {
"properties": {
"workflowIds": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (a GUID/UUID)",
"readOnly": false
}
}
},
"workflows": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"status": {
"type": "object",
"format": "metadata",
"readOnly": false,
"description": "Indicates the status of the workflow as a whole.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"description": "The unique identifier",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "In progress",
"readOnly": true
}
}
},
"functionalStatus": {
"type": "object",
"format": "metadata",
"readOnly": false,
"description": "Indicates the status of the workflow as a whole.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"description": "The unique identifier",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"description": "The current functional status of the workflow. This further specifies the `status`",
"example": "Rejected",
"readOnly": true
}
}
},
"canBeEditedByInitiator": {
"type": "boolean",
"description": "Indicates if the initiator of the worflow is allowed to change the/some of the values of the initial request",
"readOnly": true
},
"canBeCancelledByInitiator": {
"type": "boolean",
"description": "Indicates if the initiator of the worflow is allowed to change the/some of the values of the initial request",
"readOnly": true
},
"currentTask": {
"type": [
"object",
"null"
],
"properties": {
"type": {
"type": "string",
"description": "The type of the currently active task.",
"example": "InputTask",
"readOnly": true
}
}
},
"assignees": {
"type": "array",
"description": "A workflow is assigned to one or more roles.",
"items": {
"type": "object",
"properties": {
"user": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"initials": {
"type": "string",
"example": "W",
"readOnly": true
},
"prefix": {
"type": "string",
"example": "van de",
"readOnly": true
},
"lastName": {
"type": "string",
"example": "Ven",
"readOnly": true
},
"formattedName": {
"type": "string",
"example": "van de Ven W",
"readOnly": true
}
}
},
"role": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"description": {
"type": "string",
"example": "Employer",
"description": "A description of the role.",
"readOnly": true
}
}
},
"userResponsibility": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"description": {
"type": "string",
"example": "Payroll professional",
"description": "A description of the user responsibility",
"readOnly": true
}
}
}
}
}
},
"trigger": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "Indicates the trigger that started the workflow.\n\n`trigger` is a metadata field within the employer context. Possible values can be managed by the user. ",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"description": {
"type": "string",
"example": "Address change for employee",
"readOnly": true
}
}
},
"workflowTemplate": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "Indicates what workflow template was used to initiate the workflow.\n\n`workflowTemplate` is a metadata field within the employer context. Possible values can be managed by the user. ",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"description": {
"type": "string",
"example": "Approval by employer",
"maxLength": 256,
"readOnly": true
}
}
},
"allowedTransitions": {
"type": [
"object",
"null"
],
"readOnly": true,
"description": "In this object the possible transitions are returned.\nBy 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.",
"properties": {
"description": {
"type": [
"string",
"null"
],
"example": "Controleer de vergoedingen",
"description": "The description of the transition (task)",
"maxLength": 256,
"readOnly": true
},
"href": {
"type": "string",
"example": "https://api.loket.nl/v2/v2/providers/employers/workflows/{workflowId}/transition",
"readOnly": true
},
"httpVerb": {
"type": "string",
"format": "enum",
"readOnly": true,
"enum": [
"POST",
"PATCH",
"PUT"
]
},
"transitions": {
"type": "array",
"readOnly": true,
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"format": "uuid",
"description": "The unique identifier for the action to be taken",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"description": {
"type": "string",
"example": "Approve",
"description": "Description of the action",
"readOnly": true
},
"data": {
"type": "object",
"properties": {}
}
}
}
}
}
},
"comment": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"userId": {
"$ref": "#/components/schemas/id"
},
"timestamp": {
"type": "string",
"format": "date-time",
"example": "2019-11-23T11:14:06Z",
"readOnly": true
},
"text": {
"type": "string",
"description": "The text of the comment",
"example": "Moving house",
"readOnly": true
}
}
},
"initiatedOn": {
"type": "string",
"format": "date-time",
"example": "2019-11-23T11:14:06Z",
"readOnly": true
},
"initiatedBy": {
"$ref": "#/components/schemas/userBasicNotNullable"
},
"lastModifiedOn": {
"type": "string",
"format": "date-time",
"example": "2019-11-23T11:14:06Z",
"description": "date and time on which the last modification on the workflow was performed. This can be either by the system or a user.",
"readOnly": true
},
"lastModifiedBy": {
"$ref": "#/components/schemas/userBasicNotNullable"
},
"apiPayload": {
"type": "string",
"description": "The json of the initiation payload",
"example": "{\"phoneNumber\":\"040-1234567\",\"mobilePhoneNumber\":\"06-12345678\",\"emailAddress\":\"test@email.com\",\"comment\":\"ESS contact workflow!\"}",
"readOnly": true
},
"apiParams": {
"type": "object",
"description": "Key value map containing all the parameters used in the initiation request",
"example": {
"employeeId": "d037bf68-d783-423b-b8e0-45aff6fe46b6",
"contactId": "d037bf68-d783-423b-b8e0-45aff6fe46b6"
},
"readOnly": true,
"properties": {}
},
"comments": {
"type": "array",
"description": "In this object the possible comments are returned.",
"readOnly": true,
"items": {
"type": "object",
"properties": {
"commentedBy": {
"$ref": "#/components/schemas/userBasicNotNullable"
},
"commentedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time on which the comment was made.",
"example": "2019-11-23T11:14:06Z",
"readOnly": true
},
"comment": {
"type": "string",
"description": "The text of the comment",
"maxLength": 1000,
"example": "Comment to initiator",
"readOnly": true
}
}
}
},
"apiViewModel": {
"type": "object",
"format": "application/json",
"description": "The model provides the other processes with all the information they require. This is a snapshot of the moment of submitting/starting the workflow.\n\ndue to the dynamic nature of this object the following filtering operators are not supported: gt, ge, lt and le",
"example": "{\"phoneNumber\":\"040-1234567\",\"mobilePhoneNumber\":\"06-12345678\",\"emailAddress\":\"test@email.com\",\"comment\":\"ESS contact workflow!\"}",
"readOnly": true
}
}
},
"transition": {
"type": [
"object",
"null"
],
"description": "Because this object is dynamic based on the transition and workflow we give a few examples here.",
"properties": {
"action": {
"type": "string",
"format": "uuid"
},
"description": {
"type": "string"
},
"input": {
"type": [
"string",
"null"
],
"properties": {}
},
"comment": {
"type": [
"string",
"null"
],
"description": "leave a comment to the initiator of the workflow",
"minLength": 1,
"maxLength": 1000,
"readOnly": false
}
}
},
"assignee-2": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"assigneeType": {
"type": "string",
"enum": [
"UserType",
"UserResponsibility"
],
"readOnly": false
},
"description": {
"type": [
"string",
"null"
],
"readOnly": true
}
}
},
"task-2": {
"type": "object",
"properties": {
"taskId": {
"type": "integer",
"readOnly": false,
"minimum": 1
},
"taskType": {
"type": "string",
"enum": [
"Notification",
"Approval",
"Task"
],
"readOnly": false
},
"description": {
"type": [
"string",
"null"
],
"readOnly": false,
"maxLength": 1000
},
"sendEmail": {
"type": [
"boolean",
"null"
],
"readOnly": false
},
"executedBy": {
"$ref": "#/components/schemas/idNullable"
},
"executedOn": {
"type": "string",
"format": "date-time",
"example": "2019-11-23T11:14:06Z",
"description": "date and time on which the task was executed. This can be either by the system or a user.",
"readOnly": true
},
"status": {
"type": "object",
"format": "metadata",
"readOnly": false,
"description": "Indicates the status of the workflow task.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"description": "The unique identifier",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Success",
"readOnly": true
}
}
},
"assignees": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/assignee-2"
},
"readOnly": false
},
"comments": {
"type": "array",
"description": "In this object the possible comments are returned.",
"readOnly": true,
"items": {
"type": "object",
"properties": {
"commentedBy": {
"$ref": "#/components/schemas/userBasicNotNullable"
},
"commentedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time on which the comment was made.",
"example": "2019-11-23T11:14:06Z",
"readOnly": true
},
"comment": {
"type": "string",
"description": "The text of the comment",
"maxLength": 1000,
"example": "Comment to initiator",
"readOnly": true
}
}
}
}
}
},
"workflowprogress": {
"type": [
"object"
],
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"status": {
"type": "object",
"format": "metadata",
"readOnly": false,
"description": "Indicates the status of the workflow as a whole.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"description": "The unique identifier",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "In progress",
"readOnly": true
}
}
},
"functionalStatus": {
"type": "object",
"format": "metadata",
"readOnly": false,
"description": "Indicates the status of the workflow as a whole.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"description": "The unique identifier",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"description": "The current functional status of the workflow. This further specifies the `status`",
"example": "Rejected",
"readOnly": true
}
}
},
"canBeEditedByInitiator": {
"type": "boolean",
"description": "Indicates if the initiator of the worflow is allowed to change the/some of the values of the initial request",
"readOnly": true
},
"canBeCancelledByInitiator": {
"type": "boolean",
"description": "Indicates if the initiator of the worflow is allowed to change the/some of the values of the initial request",
"readOnly": true
},
"trigger": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "Indicates the trigger that started the workflow.\n\n`trigger` is a metadata field within the employer context. Possible values can be managed by the user. ",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"description": {
"type": "string",
"example": "Address change for employee",
"readOnly": true
}
}
},
"initiatedOn": {
"type": "string",
"format": "date-time",
"example": "2019-11-23T11:14:06Z",
"readOnly": true
},
"initiatedBy": {
"$ref": "#/components/schemas/userBasicNotNullable"
},
"lastModifiedOn": {
"type": "string",
"format": "date-time",
"example": "2019-11-23T11:14:06Z",
"description": "date and time on which the last modification on the workflow was performed. This can be either by the system or a user.",
"readOnly": true
},
"lastModifiedBy": {
"$ref": "#/components/schemas/userBasicNotNullable"
},
"apiPayload": {
"type": "string",
"description": "The json of the initiation payload",
"example": "{\"phoneNumber\":\"040-1234567\",\"mobilePhoneNumber\":\"06-12345678\",\"emailAddress\":\"test@email.com\",\"comment\":\"ESS contact workflow!\"}",
"readOnly": true
},
"apiViewModel": {
"type": "object",
"format": "application/json",
"description": "The model provides the other processes with all the information they require. This is a snapshot of the moment of submitting/starting the workflow.\n\ndue to the dynamic nature of this object the following filtering operators are not supported: gt, ge, lt and le",
"example": "{\"phoneNumber\":\"040-1234567\",\"mobilePhoneNumber\":\"06-12345678\",\"emailAddress\":\"test@email.com\",\"comment\":\"ESS contact workflow!\"}",
"readOnly": true
},
"tasks": {
"type": "array",
"maxItems": 6,
"items": {
"$ref": "#/components/schemas/task-2"
}
}
}
},
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 156,
"minimum": 1,
"description": "The employee number to uniquely identify an employee within an employer\n",
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Personeelsnummer"
},
"initials-2": {
"type": "string",
"example": "S.L.",
"description": "The initials\n",
"minLength": 1,
"maxLength": 6,
"readOnly": false,
"x-loket-db-field": "Loket.(Persoon/Partner/Kind).Voorletters"
},
"personalDetails": {
"type": "object",
"readOnly": false,
"properties": {
"firstName": {
"$ref": "#/components/schemas/firstName"
},
"lastName": {
"$ref": "#/components/schemas/lastName"
},
"prefix": {
"$ref": "#/components/schemas/prefix"
},
"initials": {
"$ref": "#/components/schemas/initials-2"
},
"lastNamePartner": {
"type": [
"string",
"null"
],
"example": "Wiel",
"description": "The last name of the employee's partner.",
"maxLength": 25,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.PartnerAchternaam"
},
"prefixPartner": {
"type": [
"string",
"null"
],
"example": "van de",
"description": "The prefix to the last name of the employee's partner.",
"maxLength": 10,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.PartnerVoorvoegsel"
},
"formattedName": {
"type": "string",
"example": "Wiel - van Bergen S.L. van de",
"description": "Formatted name of the employee based on the value of `howToFormatLastName`",
"maxLength": 82,
"readOnly": true,
"x-loket-implementation": "Dit veld is een samenvoegsel van de losse naam elementen. De logica voor het opbouwen van de naam is gelijk aan de logica in Loket.vwVolledigeNaam"
},
"dateOfBirth": {
"$ref": "#/components/schemas/dateOfBirth"
},
"placeOfBirth": {
"$ref": "#/components/schemas/placeOfBirth"
},
"dateOfDeath": {
"$ref": "#/components/schemas/dateOfDeath"
},
"aowDate": {
"type": "string",
"format": "date",
"example": "2062-08-21",
"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.",
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.DatumAOW"
},
"photo": {
"type": [
"string",
"null"
],
"format": "url",
"example": "https://api.loket.nl/v2/v2/providers/employers/employees/{employeeId}/photo/{version}",
"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.",
"readOnly": true
},
"howToFormatLastName": {
"$ref": "#/components/schemas/howToFormatLastName"
},
"title": {
"$ref": "#/components/schemas/title"
},
"nationality": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": false,
"x-loket-implementation": "0 = null",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The key for the nationality. Possible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Nationaliteit"
},
"value": {
"type": "string",
"example": "Dutch",
"description": "Description of the nationality",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctNationaliteit.Omschrijving"
}
}
},
"gender": {
"$ref": "#/components/schemas/gender"
},
"civilStatus": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The civil/marital status of the employee\n",
"x-loket-implementation": "0 = null",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.BurgelijkeStaat"
},
"value": {
"type": "string",
"example": "Maried",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBurgelijkeStaat.Omschrijving"
}
}
}
}
},
"contactInformation2021-03-29": {
"type": "object",
"properties": {
"phoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 13-1234567",
"description": "The phone number of the employee.",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Telefoon"
},
"mobilePhoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 6-1231456",
"description": "The mobile phone number of the employee.",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Mobiel"
},
"faxNumber": {
"type": [
"string",
"null"
],
"example": "+31 13-1234561",
"description": "The fax number to contact this individual",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Fax"
},
"emailAddress": {
"type": [
"string",
"null"
],
"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])))$",
"example": "info@loket.nl",
"description": "The e-mail address of the employee.",
"maxLength": 255,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Email"
},
"businessPhoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 13-1234567",
"description": "The business phone number of the employee.",
"maxLength": 15,
"readOnly": false
},
"businessMobilePhoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 6-1231456",
"description": "The business mobile phone number of the employee.",
"maxLength": 15,
"readOnly": false
},
"businessEmailAddress": {
"type": [
"string",
"null"
],
"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])))$",
"example": "info@loket.nl",
"description": "The business e-mail address of the employee.",
"maxLength": 255,
"readOnly": false
}
}
},
"identityDocument": {
"type": [
"object",
"null"
],
"readOnly": false,
"x-loket-implementation": "Indien de typeOfDocument.key = 0 dan het veld NULL maken. Bij een PUT of POST indien identityDocument null is dan typeOfDocument.key op 0 stellen en documentIdentification leeg maken/laten",
"properties": {
"typeOfDocument": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The key for the type of document. Possible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.SoortIdentificatieDocument"
},
"value": {
"type": "string",
"example": "Passport",
"description": "Description of the type of document",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctIdentificatieDocument.Omschrijving"
}
}
},
"documentIdentification": {
"type": "string",
"example": "CRE45553433",
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.NummerIdentificatieDocument"
}
}
},
"travel": {
"type": "object",
"readOnly": false,
"properties": {
"travelDistanceToWork": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 32,
"description": "The one way distance in meters the employee has to travel to work.\n",
"minimum": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.AfstandWoonWerk"
},
"travelDistanceToWorkInKm": {
"type": [
"number",
"null"
],
"format": "double",
"example": 41.05,
"description": "The one way distance in kilometers the employee has to travel to work.\n",
"minimum": 1,
"readOnly": true
}
}
},
"address-3": {
"type": [
"object",
"null"
],
"x-loket-comment": "Hier wordt niet gebruik gemaakt van de address definitie in SharedComponents omdat employee geen provincie heeft.",
"properties": {
"street": {
"type": "string",
"example": "Voordijk",
"description": "Streetname of the address",
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Straatnaam"
},
"city": {
"type": "string",
"example": "Leiden",
"maxLength": 24,
"description": "City of the address",
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Plaatsnaam"
},
"houseNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"description": "House number of the address",
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Huisnummer"
},
"houseNumberAddition": {
"type": [
"string",
"null"
],
"example": "D",
"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.",
"maxLength": 4,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Huisnummertoevoeging"
},
"furtherIndication": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the further indication ('nadere aanduiding'). Possible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.NadereAanduiding"
},
"value": {
"type": "string",
"example": "WW",
"description": "The description of the further indication ('nadere aanduiding'), the possible values are \"WW\" and \"AB\"",
"readOnly": true,
"x-loket-db-field": "dbo.ctNadereAanduiding.Omschrijving"
}
}
},
"postalCode": {
"type": "string",
"example": "1234 AA",
"description": "The postal code of the address, only nullable if country is not The Netherlands (NL).",
"minLength": 1,
"maxLength": 9,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Postcode",
"x-loket-implementation": "Indien land = NL moet de postcode aan de regex van NL voldoen (9999 aa)"
},
"location": {
"type": [
"string",
"null"
],
"example": "Fourth floor or building C",
"description": "The location like to further specify the address ",
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Locatie"
},
"country": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the country. Possible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Land"
},
"value": {
"type": "string",
"example": "Netherlands",
"description": "The name of the country",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.Omschrijving"
},
"isoCode": {
"type": "string",
"example": "NL",
"description": "The ISO 3166-1 alpha-2 value for the country",
"maxLength": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.IsoCode"
}
}
}
}
},
"deviatingPostalAddress-2": {
"type": [
"object",
"null"
],
"properties": {
"street": {
"type": [
"string",
"null"
],
"example": "Voordijk",
"description": "Streetname of the address",
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "StraatnaamAfwijkend"
},
"city": {
"type": "string",
"example": "Leiden",
"maxLength": 24,
"description": "City of the address",
"readOnly": false,
"x-loket-db-field": "PlaatsnaamAfwijkend"
},
"houseNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"description": "House number of the address",
"readOnly": false,
"x-loket-db-field": "HuisnummerAfwijkend"
},
"houseNumberAddition": {
"type": [
"string",
"null"
],
"example": "D",
"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.",
"maxLength": 4,
"readOnly": false,
"x-loket-db-field": "HuisnummertoevoegingAfwijkend"
},
"furtherIndication": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the further indication. Possible values can be aquired by the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "NadereAanduidingAfwijkend"
},
"value": {
"type": "string",
"example": "WW",
"description": "The description of the further indication, the possible values are \"WW\" and \"AB\"",
"readOnly": true,
"x-loket-db-field": "dbo.ctNadereAanduiding.Omschrijving"
}
}
},
"postalCode": {
"type": "string",
"example": "1234 AA",
"description": "The postal code of the address, only nullable if country is not The Netherlands (NL).",
"minLength": 1,
"maxLength": 9,
"readOnly": false,
"x-loket-db-field": "PostcodeAfwijkend",
"x-loket-implementation": "Indien land = NL moet de postcode aan de regex van NL voldoen (9999 aa)"
},
"location": {
"type": [
"string",
"null"
],
"example": "Fourth floor or building C",
"description": "The location like to further specify the address ",
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "LocatieAfwijkend"
},
"country": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the country. Possible values can be aquired by the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "LandAfwijkend"
},
"value": {
"type": "string",
"example": "Netherlands",
"description": "The name of the country",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.Omschrijving"
},
"isoCode": {
"type": "string",
"example": "NL",
"description": "The ISO 3166-1 alpha-2 value for the country",
"maxLength": 2,
"readOnly": false,
"x-loket-db-field": "dbo.ctLand.IsoCode"
}
}
}
}
},
"exclusionFromAbsenceStatus": {
"type": "boolean",
"example": false,
"description": "Indicates whether the employee is excluded for any information of absence\n",
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.UitsluitingVerzuimStatus"
},
"statusEmployeeSelfService": {
"type": [
"object",
"null"
],
"format": "metadata",
"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",
"readOnly": true,
"x-loket-implementation": "Indien de waarde van key 0 is het object statusEmployeeSelfService op null stellen.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.StatusWerknemerLoket"
},
"value": {
"type": "string",
"example": "Blocked",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctStatusWerknemerLoket.Omschrijving"
}
}
},
"revokeEmployeeSelfServiceAccessOn": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The date on which the Employee will be automatically blocked.\n",
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.DatumBlokkerenWerknemerLoket"
},
"employee2021-03-29": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"employeeNumber": {
"$ref": "#/components/schemas/employeeNumber"
},
"personalDetails": {
"$ref": "#/components/schemas/personalDetails"
},
"contactInformation": {
"$ref": "#/components/schemas/contactInformation2021-03-29"
},
"identityDocument": {
"$ref": "#/components/schemas/identityDocument"
},
"travel": {
"$ref": "#/components/schemas/travel"
},
"address": {
"$ref": "#/components/schemas/address-3"
},
"deviatingPostalAddress": {
"$ref": "#/components/schemas/deviatingPostalAddress-2"
},
"exclusionFromAbsenceStatus": {
"$ref": "#/components/schemas/exclusionFromAbsenceStatus"
},
"statusEmployeeSelfService": {
"$ref": "#/components/schemas/statusEmployeeSelfService"
},
"revokeEmployeeSelfServiceAccessOn": {
"$ref": "#/components/schemas/revokeEmployeeSelfServiceAccessOn"
}
}
},
"contactInformation-2": {
"type": "object",
"properties": {
"phoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 13-1234567",
"description": "The phone number of the employee.",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Telefoon"
},
"mobilePhoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 6-1231456",
"description": "The mobile phone number of the employee.",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Mobiel"
},
"faxNumber": {
"type": [
"string",
"null"
],
"example": "+31 13-1234561",
"description": "The fax number to contact this individual",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Fax"
},
"emailAddress": {
"type": [
"string",
"null"
],
"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])))$",
"example": "info@loket.nl",
"description": "The e-mail address of the employee.",
"maxLength": 255,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Email"
}
}
},
"employee2018-12-31": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"employeeNumber": {
"$ref": "#/components/schemas/employeeNumber"
},
"personalDetails": {
"$ref": "#/components/schemas/personalDetails"
},
"contactInformation": {
"$ref": "#/components/schemas/contactInformation-2"
},
"identityDocument": {
"$ref": "#/components/schemas/identityDocument"
},
"travel": {
"$ref": "#/components/schemas/travel"
},
"address": {
"$ref": "#/components/schemas/address-3"
},
"deviatingPostalAddress": {
"$ref": "#/components/schemas/deviatingPostalAddress-2"
},
"exclusionFromAbsenceStatus": {
"$ref": "#/components/schemas/exclusionFromAbsenceStatus"
},
"statusEmployeeSelfService": {
"$ref": "#/components/schemas/statusEmployeeSelfService"
},
"revokeEmployeeSelfServiceAccessOn": {
"$ref": "#/components/schemas/revokeEmployeeSelfServiceAccessOn"
}
}
},
"emailAddress": {
"properties": {
"emailAddress": {
"type": [
"string",
"null"
],
"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])))$",
"example": "info@loket.nl",
"description": "The e-mail address of the employee.",
"maxLength": 255,
"readOnly": false
}
}
},
"employeeContact": {
"type": "object",
"x-loket-db": "De velden zijn te vinden in loket.PersoonContact",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"example": "Johanna Bakker",
"description": "Name of the contact",
"maxLength": 70,
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Naam"
},
"description": {
"type": "string",
"example": "Moeder",
"description": "Describes the relationship of the contact to the employee",
"maxLength": 50,
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Kenmerk"
},
"phoneNumber": {
"type": [
"string",
"null"
],
"example": "013-12345678",
"description": "The phone number of the contact",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Telefoon"
},
"address": {
"type": [
"object",
"null"
],
"x-loket-comment": "Hier wordt niet gebruik gemaakt van de address definitie in SharedComponents omdat PersoonContact geen provincie en locatie heeft.",
"properties": {
"street": {
"type": "string",
"example": "Voordijk",
"description": "Streetname of the address",
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Straatnaam"
},
"city": {
"type": "string",
"example": "Leiden",
"maxLength": 24,
"description": "City of the address",
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Plaatsnaam"
},
"houseNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"description": "House number of the address",
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Huisnummer"
},
"houseNumberAddition": {
"type": [
"string",
"null"
],
"example": "D",
"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.",
"maxLength": 4,
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Huisnummertoevoeging"
},
"postalCode": {
"type": [
"string",
"null"
],
"example": "1234 AA",
"description": "The postal code of the address",
"maxLength": 9,
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Postcode"
},
"country": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the country. Possible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Land"
},
"value": {
"type": "string",
"example": "Netherlands",
"description": "The name of the country",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.Omschrijving"
},
"isoCode": {
"type": "string",
"example": "NL",
"description": "The ISO 3166-1 alpha-2 value for the country",
"maxLength": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.IsoCode"
}
}
}
}
},
"particularities": {
"type": [
"string",
"null"
],
"example": "Genoemd adres is een priveadres",
"description": "Extra information about the contact",
"maxLength": 4000,
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Bijzonderheden"
},
"emailAddress": {
"type": [
"string",
"null"
],
"example": "johanna.bakker@example.com",
"description": "The email address of the contact",
"maxLength": 255,
"readOnly": false,
"x-loket-db-field": "Loket.PersoonContact.Emailadres"
}
}
},
"child": {
"type": "object",
"x-loket-db": "De velden zijn te vinden in loket.Kind",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"firstName": {
"$ref": "#/components/schemas/firstName"
},
"lastName": {
"$ref": "#/components/schemas/lastName"
},
"prefix": {
"$ref": "#/components/schemas/prefix"
},
"initials": {
"$ref": "#/components/schemas/initials-2"
},
"dateOfBirth": {
"$ref": "#/components/schemas/dateOfBirth"
},
"dateOfDeath": {
"$ref": "#/components/schemas/dateOfDeath"
},
"gender": {
"$ref": "#/components/schemas/gender"
},
"residenceStatus": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": false,
"description": "Indicator to tell if the child is living at home or not. Use null if unknown.\n",
"x-loket-implementation": "Indien 0 dan NULL bij GET en andersom bij POST/PUT",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The key for the residence status",
"readOnly": false,
"x-loket-db-field": "dbo.ctverblijf.code"
},
"value": {
"type": "string",
"example": "Living at home",
"description": "Is the child living with his parent",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctverblijf.omschrijving"
}
}
}
}
},
"occupationalDisability": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2017-05-21",
"description": "The startdate of the record\n\nA (broken chain)[./#section/Data/Date-chains] is maintained within this resource.",
"readOnly": false,
"x-loket-db-field": "Loket.WAO.DatumIngang"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-01-21",
"description": "end date",
"readOnly": false,
"x-loket-db-field": "Loket.WAO.DatumEinde"
},
"classification": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The occupational disability classification in the form of a percentage range.",
"x-loket-implementation": "In het geval dat WAOKlasse 0 is, dit veld NULL maken",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The key of the occupational disability classification. Possible values can be acquired via the metadata endpoint.\n",
"readOnly": true,
"x-loket-db-field": "Loket.WAO.WAOKlasse"
},
"value": {
"type": "string",
"example": "15 - 24",
"description": "Description of the occupational disability classification.\n",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctWAOKlasse",
"x-loket-implementation": "De omschrijving van het record met code 1 bevat een leading space. Deze willen we eruit filteren"
}
}
},
"isOccupationallyDisabled": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Indicates whether the employee is incapacitated.",
"readOnly": false,
"x-loket-db-field": "Loket.WAO.Arbeidsgehandicapt",
"x-loket-implemenation": "In het geval van een waarde 0 in de database, hier een NULL terug geven."
},
"isExWAO": {
"type": [
"boolean",
"null"
],
"example": true,
"description": "Indicates whether the employee has received WAO payments before.",
"readOnly": false,
"x-loket-db-field": "Loket.WAO.ExWAOer",
"x-loket-implemenation": "In het geval van een waarde 0 in de database, hier een NULL terug geven."
}
}
},
"partner": {
"type": "object",
"x-loket-db": "De velden zijn te vinden in loket.Partner",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "1995-05-21",
"description": "startdate",
"readOnly": false,
"x-loket-db-field": "Loket.partner.DatumIngang"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "1995-05-21",
"description": "end date",
"readOnly": false,
"x-loket-db-field": "Loket.partner.DatumEinde"
},
"firstName": {
"$ref": "#/components/schemas/firstName"
},
"lastName": {
"$ref": "#/components/schemas/lastName"
},
"prefix": {
"$ref": "#/components/schemas/prefix"
},
"initials": {
"type": [
"string",
"null"
],
"example": "S.L.",
"description": "The initials\n",
"minLength": 1,
"maxLength": 6,
"readOnly": false,
"x-loket-db-field": "Loket.Partner.Voorletters"
},
"dateOfBirth": {
"$ref": "#/components/schemas/dateOfBirth"
},
"placeOfBirth": {
"$ref": "#/components/schemas/placeOfBirth"
},
"dateOfDeath": {
"$ref": "#/components/schemas/dateOfDeath"
},
"howToFormatLastName": {
"type": "object",
"format": "metadata",
"readOnly": false,
"description": "Indicates how the system will format the last name.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.(Persoon/Partner).GebruikAchternaam"
},
"value": {
"type": "string",
"example": "last name + last name partner",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctGebruikAchternaamPartner.Omschrijving"
}
}
},
"title": {
"$ref": "#/components/schemas/title"
},
"gender": {
"$ref": "#/components/schemas/gender"
},
"waoClassification": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The occupational disability classification in the form of a percentage range.",
"readOnly": false,
"x-loket-implementation": "In het geval dat WAOKlasse 0 is, dit veld NULL maken",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The key of the occupational disability classification. Possible values can be acquired via the metadata endpoint.\n",
"readOnly": false,
"x-loket-db-field": "Loket.Partner.WAOKlasse"
},
"value": {
"type": "string",
"example": "15 - 24",
"description": "Description of the occupational disability classification.\n",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctWAOKlasse",
"x-loket-implementation": "De omschrijving van het record met code 1 bevat een leading space. Deze willen we eruit filteren"
}
}
}
}
},
"citizenServiceNumber": {
"type": [
"string",
"null"
],
"example": "042168588",
"minLength": 9,
"maxLength": 9,
"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).",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.BSN / loket.persoon.sofinummer"
},
"citizenServiceNumber-2": {
"type": "object",
"properties": {
"citizenServiceNumber": {
"$ref": "#/components/schemas/citizenServiceNumber"
}
}
},
"logoPostObject": {
"properties": {
"data": {
"type": "string",
"example": "YQ==",
"description": "base64 encoded document file.",
"readOnly": false
},
"mimeType": {
"type": "string",
"example": "image/jpeg",
"description": "The mimetype of the data.",
"readOnly": false
}
}
},
"employee": {
"type": "object",
"properties": {
"employeeNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 156,
"description": "The employee number to uniquely identify an employee within an employer.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Personeelsnummer"
},
"personalDetails": {
"type": "object",
"description": "The personal details of the employee. e.g. Name, civil status en gender",
"properties": {
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name of the employee.",
"maxLength": 28,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Roepnaam"
},
"lastName": {
"type": "string",
"example": "Bergen",
"description": "The last name of the employee.",
"maxLength": 25,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Geboortenaam"
},
"prefix": {
"type": [
"string",
"null"
],
"example": "van",
"description": "The prefix to the last name of the employee.",
"maxLength": 10,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Voorvoegsel"
},
"initials": {
"type": [
"string",
"null"
],
"example": "S.L.",
"description": "The initials of the employee.",
"maxLength": 6,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Voorletters"
},
"formattedName": {
"type": [
"string",
"null"
],
"example": "Wiel - van Bergen S.L. van de",
"description": "Formatted name of the employee based on the value of `howToFormatLastName`",
"maxLength": 82,
"readOnly": true,
"x-loket-implementation": "Dit veld is een samenvoegsel van de losse naam elementen. De logica voor het opbouwen van de naam is gelijk aan de logica in Loket.vwVolledigeNaam"
},
"lastNamePartner": {
"type": [
"string",
"null"
],
"example": "Wiel",
"description": "The last name of the employee`s partner.",
"maxLength": 25,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.AchternaamPartner"
},
"prefixPartner": {
"type": [
"string",
"null"
],
"example": "van de",
"description": "The prefix to the last name of the employee\"s partner.",
"maxLength": 10,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.PartnerVoorvoegsel"
},
"dateOfBirth": {
"type": [
"string",
"null"
],
"format": "date",
"example": "1995-05-21",
"description": "The date of birth of the employee.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Geboortedatum"
},
"placeOfBirth": {
"type": [
"string",
"null"
],
"example": "Amsterdam",
"description": "Place of birth of the employee",
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Geboorteplaats"
},
"howToFormatLastName": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates how the system will format `formattedName`. ",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.GebruikAchternaam"
},
"value": {
"type": "string",
"example": "last name + last name partner",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctGebruikAchternaam.Omschrijving"
}
}
},
"title": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The title to be used (if any).",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Titulatuur"
},
"value": {
"type": "string",
"example": "e.g. Msc, PHD or Baron",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctTitulatuur.Omschrijving"
}
}
},
"gender": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The gender of the employee",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Geslacht"
},
"value": {
"type": "string",
"example": "female",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctGeslacht.Omschrijving"
}
}
},
"nationality": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The nationality of the employee",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Nationaliteit"
},
"value": {
"type": "string",
"example": "Dutch",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctNationaliteit.Omschrijving"
}
}
},
"civilStatus": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The civil status of the employee",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.BurgelijkeStaat"
},
"value": {
"type": "string",
"example": "Married",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBurgelijkeStaat.Omschrijving"
}
}
}
}
},
"contactInformation": {
"type": [
"object",
"null"
],
"description": "Contact information for the employee",
"properties": {
"phoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 13-1234567",
"description": "The phone number of the employee.",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Telefoon"
},
"mobilePhoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 6-1231456",
"description": "The mobile phone number of the employee.",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Mobiel"
},
"faxNumber": {
"type": [
"string",
"null"
],
"example": "+31 13-1234561",
"description": "The fax number to contact this individual",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Fax"
},
"emailAddress": {
"type": [
"string",
"null"
],
"example": "info@loket.nl",
"description": "The e-mail address of the employee.",
"maxLength": 255,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Email"
}
}
},
"identityDocument": {
"type": [
"object",
"null"
],
"description": "The identification document of the employee",
"properties": {
"typeOfDocument": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The key for the type of document. Possible values can be acquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.SoortIdentificatieDocument"
},
"value": {
"type": "string",
"example": "Passport",
"description": "Description of the type of document",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctIdentificatieDocument.Omschrijving"
}
}
},
"documentIdentification": {
"type": [
"string",
"null"
],
"example": "CRE45553433",
"description": "Description of the type of document",
"maxLength": 20,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.NummerIdentificatieDocument"
}
}
},
"address": {
"type": [
"object",
"null"
],
"description": "The address of the employee",
"properties": {
"street": {
"type": [
"string",
"null"
],
"example": "Voordijk",
"description": "Streetname of the address",
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Straatnaam"
},
"city": {
"type": [
"string",
"null"
],
"example": "Leiden",
"maxLength": 24,
"description": "City of the address",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Plaatsnaam"
},
"houseNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 12,
"description": "House number of the address",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Huisnummer"
},
"houseNumberAddition": {
"type": [
"string",
"null"
],
"example": "D",
"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.",
"maxLength": 4,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Huisnummertoevoeging"
},
"furtherIndication": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Futher indication of the address for example onboard (a ship) or living in a trailer",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.NadereAanduiding"
},
"value": {
"type": "string",
"example": "WW",
"readOnly": true,
"x-loket-db-field": "dbo.ctNadereAanduiding.Omschrijving"
}
}
},
"postalCode": {
"type": [
"string",
"null"
],
"example": "1234 AA",
"description": "The postal code of the address",
"maxLength": 9,
"readOnly": false,
"x-loket-db-field": "Postcode"
},
"location": {
"type": [
"string",
"null"
],
"example": "Fourth floor or building C",
"description": "The location like to further specify the address",
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "Locatie"
},
"country": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The country of residence of the employee",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Land"
},
"value": {
"type": "string",
"example": "Netherlands",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.Omschrijving"
},
"isoCode": {
"type": "string",
"example": "NL",
"maxLength": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.IsoCode"
}
}
}
}
},
"deviatingPostalAddress": {
"type": [
"object",
"null"
],
"description": "The deviating address of the employee (used as a postal address)",
"properties": {
"street": {
"type": [
"string",
"null"
],
"example": "Voordijk",
"description": "Streetname of the address",
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "StraatnaamAfwijkend"
},
"city": {
"type": [
"string",
"null"
],
"example": "Leiden",
"maxLength": 24,
"description": "City of the address",
"readOnly": false,
"x-loket-db-field": "PlaatsnaamAfwijkend"
},
"houseNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 12,
"description": "House number of the address",
"readOnly": false,
"x-loket-db-field": "HuisnummerAfwijkend"
},
"houseNumberAddition": {
"type": [
"string",
"null"
],
"example": "D",
"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.",
"maxLength": 4,
"readOnly": false,
"x-loket-db-field": "HuisnummertoevoegingAfwijkend"
},
"furtherIndication": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Futher indication of the address for example onboard (a ship) or living in a trailer",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "NadereAanduidingAfwijkend"
},
"value": {
"type": "string",
"example": "WW",
"readOnly": true,
"x-loket-db-field": "dbo.ctNadereAanduiding.Omschrijving"
}
}
},
"postalCode": {
"type": [
"string",
"null"
],
"example": "1234 AA",
"description": "The postal code of the address",
"maxLength": 9,
"readOnly": false,
"x-loket-db-field": "PostcodeAfwijkend"
},
"location": {
"type": [
"string",
"null"
],
"example": "Fourth floor or building C",
"description": "The location like to further specify the address",
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "LocatieAfwijkend"
},
"country": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The country of residence of the employee",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "LandAfwijkend"
},
"value": {
"type": "string",
"example": "Netherlands",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.Omschrijving"
},
"isoCode": {
"type": "string",
"example": "NL",
"maxLength": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.IsoCode"
}
}
}
}
},
"iban": {
"type": [
"string",
"null"
],
"example": "NL52ABNA0424968264",
"description": "International Bank Account Number. Only IBAN without spaces are accepted.",
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "Loket.Conceptwerknemer.IBAN"
}
}
},
"employment": {
"type": [
"object",
"null"
],
"properties": {
"startDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2019-01-01",
"description": "The date on which this employment starts.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.DatumInDienst"
},
"historicalStartDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2012-05-01",
"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.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.HistorischeDatumInDienst"
},
"payrollAdministration": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "An administration used for payrolling. This field can not have a value at the same time as `nonPayrollAdministration`\n\n`payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user. ",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-implementation": "Komt uit ulsa.werkgever ipv loket.verloning"
},
"name": {
"type": "string",
"example": "ABC accountants",
"description": "Name of the administration",
"maxLength": 70,
"readOnly": true,
"x-loket-db-field": "Ulsa.Werkgever.Naam --> Dit is anders als wat we nu doen nu komt de naam uit loket.verloning.Omschrijving"
},
"clientNumber": {
"type": "integer",
"format": "int32",
"example": 1234,
"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.",
"readOnly": true,
"x-loket-db-field": "Ulsa.Werkgever.ClientNummer & Loket.Verloning.ClientNr",
"x-loket-implementation": "Het clientnummer is de verbinding tussen Ulsa.Werkgever en Loket.Verloning. Een waarde 0 in de database wordt als NULL teruggegeven in de API."
},
"description": {
"type": "string",
"example": "Bakker",
"description": "Description of the administration",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.Verloning.Omschrijving"
}
}
},
"nonPayrollAdministration": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "An administration that can not be used for payrolling. This field can not have a value at the same time as `payrollAdministration`\n\n`nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-implementation": "Komt uit loket.verloning ipv ulsa.werkgever"
},
"name": {
"type": [
"string",
"null"
],
"example": "ABC accountants",
"description": "Name of the administration",
"maxLength": 70,
"readOnly": true,
"x-loket-db-field": "loket.Verloning.Omschrijving"
},
"description": {
"type": "string",
"example": "Bakker",
"description": "Description of the administration",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.Verloning.Omschrijving"
}
}
},
"commissionUntilDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2019-01-01",
"description": "The date on which the employment will end.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.AanstellingTot"
},
"incomeRelationshipNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 12,
"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.",
"minimum": 0,
"maximum": 9999,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.NummerInkomstenVerhouding"
},
"employeeProfileId": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "References to an employeeprofile that is specified in the payroll administration level\n\n`employeeProfileId` is a metadata field within the payroll administration context. Possible values can be managed by the user. ",
"x-loket-implementation": "Let op: moet gefilterd op actieve jaar. Maw alleen profielen voor het actieve moeten worden overgenomen. als NULL dan 0 voor database",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Conceptwerknemer.WerknemerProfielID"
},
"value": {
"type": "string",
"example": "Profiel full-timers",
"readOnly": true,
"x-loket-db-field": "Ulsa.Werknemerprofiel.Omschrijving"
}
}
},
"employmentDurationType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "A selection of pre defined durations for the employment.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.SoortDienstverband"
},
"value": {
"type": "string",
"example": "Contract of indefinite duration",
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortDienstverband.Omschrijving"
}
}
},
"startDateContractOfIndefiniteDuration": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-05-08",
"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.",
"readOnly": false
},
"employmentContractType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The type of employment applicable for the employment.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.BasisDienstverband"
},
"value": {
"type": "string",
"example": "Labor agreement",
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisDienstverband.Omschrijving"
}
}
},
"typeOfEmployee": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "A selection of pre defined employee-types for the employment.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Conceptwerknemer.SoortWerknemer"
},
"value": {
"type": "string",
"example": "Werknemer",
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortWerknemer.Omschrijving"
}
}
},
"cancellationPeriodEmployee": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"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.",
"minimum": 1,
"maximum": 1000,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.OpzegtermijnWerknemer",
"x-loket-implementation": "0 = null"
},
"cancellationPeriodEmployer": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"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.",
"minimum": 1,
"maximum": 1000,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.OpzegtermijnWerkgever",
"x-loket-implementation": "0 = null"
},
"cancellationPeriodTimeUnit": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The unit of time used for the noticePeriodeEmployee and noticePeriodEmployer properties.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 4,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.PeriodeOpzegTermijn"
},
"value": {
"type": "string",
"example": "Maand(en)",
"readOnly": true,
"x-loket-db-field": "dbo.ctPeriode.Omschrijving"
}
}
},
"cancellationNoticeDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2019-05-31",
"description": "The date on which the notice was given by either the employee or the employer.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.DatumOpzegging"
},
"startCancellationNoticePeriod": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2019-06-01",
"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.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.AanvangOpzegtermijn"
},
"isDirectorAndMajorShareholder": {
"type": [
"boolean",
"null"
],
"example": false,
"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.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.IsDirecteurGrootAandeelhouder",
"x-loket-implementation": "In de database is dit een non-nullable veld. In de API vertalen we dit alsvolgt: 0 = null, 1 = true, 2 = false"
},
"isOnCallEmployment": {
"type": [
"boolean",
"null"
],
"example": true,
"description": "Indicates whether the employment is an on-call employment.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.IsOproepkrachtOfInvalkracht"
},
"hasOnCallAppearanceObligation": {
"type": [
"boolean",
"null"
],
"example": true,
"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.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.SoortOproepkrachtOfInvalkracht",
"x-loket-implementation": "In de database correspondeert dit veld met de codetabel ctSoortOproepkrachtOfInvalkracht. In de API maken we dit een nullable boolean met de volgende mapping: 0 = null, 1 = false, 2 = true. LET OP: deze mapping wijkt af van de mappings hierboven die gebaseerd zijn op de codetabel ctOnbekendJaNee."
},
"vacationCoupons": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indication for vacation coupons (vakantiebonnen). This is only applies to a limited set of CLA`s.",
"x-loket-implementation": "Indien de waarde 0 (n.v.t.) is het element NULL maken",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Vakantiebonnen"
},
"value": {
"type": "string",
"example": "n.v.t.",
"readOnly": true,
"x-loket-db-field": "dbo.ctVakantiebonnen"
}
}
},
"specialIncomeRatio": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates the special income ratio",
"x-loket-implementation": "als NULL dan 0 voor database",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": false,
"x-loket-db-field": "Loket.SoortConceptWerknemer.SpecialeInkomstenVerhouding"
},
"value": {
"type": "string",
"example": "n.v.t.",
"readOnly": true,
"x-loket-db-field": "dbo.ctSpecialeInkomstenVerhouding.Omschrijving"
}
}
},
"isAnonymousEmployee": {
"type": [
"boolean",
"null"
],
"example": true,
"description": "Indicates whether employee is anonymous ",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.IsAnoniemeWerknemer",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"isPreviousOwner": {
"type": [
"boolean",
"null"
],
"example": false,
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.SoortConceptWerknemer.IsVorigeEigenaar",
"x-loket-implementation": "In de database is dit een non-nullable veld. In de API vertalen we dit alsvolgt: 0 = null, 1 = true, 2 = false"
},
"isFamilyOfOwner": {
"type": [
"boolean",
"null"
],
"example": false,
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.SoortConceptWerknemer.IsFamilieVaneEigenaar",
"x-loket-implementation": "In de database is dit een non-nullable veld. In de API vertalen we dit alsvolgt: 0 = null, 1 = true, 2 = false"
},
"isGemoedsbezwaardNationalInsurance": {
"type": [
"boolean",
"null"
],
"example": true,
"description": "Gemoedsbezwaard Volksverzekering",
"readOnly": false,
"x-loket-db-field": "Loket.SoortConceptWerknemer.IsGemoedsbezwaardVolksverzekering",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"isGemoedsbezwaardEmployeeInsurance": {
"type": [
"boolean",
"null"
],
"example": true,
"description": "Gemoedsbezwaard Werknemerverzekering",
"readOnly": false,
"x-loket-db-field": "Loket.SoortConceptWerknemer.IsGemoedsbezwaardWerknemerverzekering",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"namePayslip": {
"type": [
"string",
"null"
],
"description": "Name that is visible on payslips for the employment",
"example": "Steve Jobs",
"maxLength": 34,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.NaamLoonstrook",
"x-loket-implementation": "Als ingevoerde waag is leeg of bestaat uit alleen spaties > NULL voor de database"
},
"calculateWorkingHours": {
"type": [
"boolean",
"null"
],
"example": true,
"description": "Automatically calculate working hours for the employment if the option automatically calculate hours is selected for a given period.",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Completeren",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"essMutationSet": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "References to a specified set of payrollcomponents that are to accessible via ESS for employee mutations\n\n`essMutationSet` is a metadata field within the werkgever/provider context. Possible values can be managed by the user. ",
"readOnly": false,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.ExportsetID"
},
"value": {
"type": "string",
"example": "Standaard",
"readOnly": true,
"x-loket-db-field": "Loket.WerkgeverExportSet",
"x-loket-implementation1": "Waarde -1 staat voor standaard ik weet echter niet of deze in de codetabel voorkomt mogelijk wordt deze door de GUI toegevoegd."
}
}
},
"exemptionInsuranceObligation": {
"type": [
"object",
"null"
],
"format": "metadata",
"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)",
"x-loket-implementation": "De 0 heeft hier een betekenis dus moet teruggegeven worden in de metadata en response",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.CodeUitzondering"
},
"value": {
"type": "string",
"example": "Geen uitzondering.",
"readOnly": true,
"x-loket-db-field": "dbo.ctCodeUitzondering"
}
}
},
"firstDayNotification": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Indicates whether first-day notification (EersteDagsMelding) is applicable for the employment",
"readOnly": true,
"x-loket-db-field": "Loket.SoortConceptWerknemer.EersteDagsMelding",
"x-loket-implementation": " In de API vertalen we dit alsvolgt: 0 = null, 1 = true, 2 = false"
},
"sendMdvNotification": {
"type": [
"boolean",
"null"
],
"example": true,
"description": "Indicate if a Mdv (melding dienstverband) should be send.",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.MdvMeldingAanmaken",
"x-loket-comment": "De waarde van dit veld is niet meer te bewerken nadat een dienstverband is aangemaakt."
},
"periodPayGradeAdjustment": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 2,
"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’.",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.PeriodeSalarisPeriodiek",
"x-loket-implementation": "als NULL dan 0 voor database"
},
"signalPayGradeAdjustment": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Indicates whether signaling regarding salary scale adjustments are enabled for the employment",
"readOnly": false,
"x-loket-db-field": "Loket.Conceptwerknemer.SalarisschaalSignaleren",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"typeOfParticipation": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The type of participation (aard van deelnemerschap) is only applicable in case the person related to this employment is eligible for pension",
"x-loket-implementation": "als NULL dan 0 voor database",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.AardDeelnemerschap"
},
"value": {
"type": "string",
"example": "n.v.t.",
"readOnly": true,
"x-loket-db-field": "dbo.ctAardDeelnemerschap"
}
}
},
"valueOfParticipation": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The value of participation (waarde van deelnemerschap) is only applicable in case the person related to this employment is eligible for pension",
"x-loket-implementation": "als NULL dan 0 voor database",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.WaardeDeelnemerschap"
},
"value": {
"type": "string",
"example": "n.v.t.",
"readOnly": true,
"x-loket-db-field": "dbo.ctWaardeDeelnemerschap"
}
}
},
"professionCode": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 4,
"description": "A code field for a profession.",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Beroep"
},
"deviatingCLATaxReturn": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 2,
"description": "CLA (CAO) code in case of a deviating CLA for tax returns .",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.CAOUWV"
},
"participation55plusRegulationUWV": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Deelname55Plus",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"emailLeaveRequest": {
"type": [
"string",
"null"
],
"description": "Recipient e-mail adress for notification in case of leave requests.",
"example": "api@loket.nl",
"maxLength": 255,
"readOnly": false,
"x-loket-implementation": "indien leeg of spaties > NULL voor database"
},
"writtenEmploymentContract": {
"type": [
"boolean",
"null"
],
"example": true,
"description": "Dit the employment and employer make a written contract?",
"readOnly": false
}
}
},
"workingHours": {
"type": [
"object",
"null"
],
"properties": {
"shift": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The shift determines the full-time hours and bonus percentage.\n\n`shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.",
"x-loket.implementation": "loket.ConceptWerknemer.Ploeg is een ID die verwijst naar ulsa.ploeg . Er zit overerving en tijdsgebonden logica aan de ploeg vast dus moet er goed gekeken worden (zoals het nu werkt in Loket) welke ulsa.ploeg.uren, ulsa.ploeg.percentage worden teruggegeven op basis van ulsa.ploeg.JaarId en ulsa.ploeg.verloningsPeriodeId (en start en eind datum van de loket.werktijd regel)",
"properties": {
"shiftNumber": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the shift. ",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Ploeg",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. let wel op dat het ID meerdere malen voor kan komen in ULSa omdat het daar uniek is samen met verlongingsperiodeID"
},
"fullTimeHoursPerWeek": {
"type": "number",
"example": 40,
"description": "The full time hours for an employment that is linked to this shift.",
"minimum": 0.01,
"maximum": 99,
"readOnly": true,
"x-loket-db-field": "Ulsa.Ploeg.Uren"
},
"bonusPercentage": {
"type": "number",
"example": 12,
"description": "The bonus percentage used in wage calculations for the hours made in this shift. ",
"minimum": 0.01,
"maximum": 99,
"readOnly": true,
"x-loket-db-field": "ulsa.ploeg.percentage"
}
}
},
"deviatingHoursPerWeek": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 32,
"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.",
"minimum": 0.01,
"maximum": 99,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.AfwijkendAantalUrenPerWeek",
"x-loket-implementation": "Indien de waarde gelijk is aan 0 een NULL teruggeven",
"x-loket-implementation2": "Minimum 0.01 is zodat er niet numerieke 0 kan worden opgevoerd door de gebruiker van de API",
"x-loket-implementation3": "Indien calculateUsingWorkPattern.deviatingDaysAndHours op true AND enddate=null; dan berekenen dit veld. [som aantal uren in workPattern] /2 , afronden op 2 decimalen"
},
"deviatingSvDaysPerPeriod": {
"type": [
"number",
"null"
],
"example": 32,
"description": "Sv (social insurance) days are normally calculated by hours per shift, this optional field is used to register a deviating value. ",
"minimum": 1,
"maximum": 23,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.AfwijkendAantalDagenPerWeek",
"x-loket-implementation": "Indien de waarde gelijk is aan 0 een NULL teruggeven",
"x-loket-implementation2": "Minimum 1 is zodat er niet numerieke 0 kan worden opgevoerd door de gebruiker van de API",
"x-loket-implementation3": "Indien calculateUsingWorkPattern.deviatingDaysAndHours op true AND endDate=null; dan berekenen dit veld. Indien 4-weken verloning; [aantal velden in workPattern met n uren != 0 ]*2 . Else; [aantal velden in workPattern met n uren != 0 ] * 26 / 12"
},
"averageParttimeFactor": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,4})?$",
"example": 37.5,
"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",
"minimum": 0.0001,
"maximum": 999.9999,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.GemiddeldeDeeltijd"
},
"regularWorkPattern": {
"type": [
"boolean",
"null"
],
"example": true,
"description": "When the employee works the same amount of hours per day every week, then the workpattern is regular. ",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.RegelmatigArbeidspatroon"
},
"flexibleHoursContract": {
"type": [
"object",
"null"
],
"description": "The field indicates the type of flexible contract. If not applicable, please set to NULL.",
"x-loket-implementation": "in db 0 ; in API NULL",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": false,
"x-loket-db-field": "loket.conceptwerknemer.FlexibelUrenContract"
},
"value": {
"type": "string",
"example": "n.v.t.",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctFlexibelUrenContract.omschrijving"
}
}
},
"contractCode": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "This field is specialy made for convenience stores. The field is the type of contract.\n\n`contractCode` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.ContractCodeID omzetten naar GUID vanuit Loket.ContractCode.ExternID"
},
"code": {
"type": "integer",
"format": "int32",
"example": 1022,
"readOnly": true,
"x-loket-db-field": "Loket.ContractCode.Code"
},
"description": {
"type": "string",
"example": "SLA-PT-met toeslagen ATW (88)",
"readOnly": true,
"x-loket-db-field": "Loket.ContractCode.Omschrijving"
}
}
},
"calculateUsingWorkPattern": {
"type": "object",
"description": "Indications in this objects determine whether specific values should be calculated based on the bi-weekly workPattern (specified in the `workPattern` object).",
"properties": {
"leaveHours": {
"type": [
"boolean",
"null"
],
"example": true,
"description": "Indicates whether then leave balances (verlof) are to be calculated based on the workpattern.",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.BerekenenVerlofEenhedenViaRooster"
},
"hoursBrokenPeriod": {
"type": [
"boolean",
"null"
],
"example": false,
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.BerekenenUrenGebrokenPeriodeViaRooster"
},
"hoursPeriod": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods. ",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.BerekenenUrenPeriodeViaRooster"
},
"daysDailyRate": {
"type": [
"boolean",
"null"
],
"example": false,
"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. ",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.DagenDagvergoedingViaRooster"
},
"deviatingDaysAndHours": {
"type": [
"boolean",
"null"
],
"example": false,
"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)!",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.AfwijkendeDagenUrenViaRooster"
}
}
},
"workPattern": {
"x-loket-implementation1": "Indien object !=null EN tenminste 1 veld heeft niet de numerieke waarde 0; dan record aanmaken/ wijzigen in Loket.WerktijdRooster. Let op; uniek op combinatie werkgever, persoon, dienstverband EN werktijdID.",
"x-loket-implementation2": "Indien object = null ; dan geen nieuw record aanmaken in Loket.WerktijdRooster.",
"x-loket-implementation3": "Let op! Als null wordt opgegeven, dient een eventueel bestaand record in Loket.WerktijdRooster te worden verwijderd.",
"x-loket-comment": "We voegen de volgende validatie toe; \"tenminste 1 van de velden in het workPattern object moet niet gelijk zijn aan 0. Als geen data, zet dan het bovenliggende object op NULL.\"",
"type": [
"object",
"null"
],
"description": "The applicable work pattern for a period of 2 weeks can be stored in this object. Each field contains the number of work hours for that day in the 2-week period.
Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0)
Each field represent the number of hours the employee normally works on that day.\n",
"properties": {
"oddWeeks": {
"type": "object",
"properties": {
"monday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenMaandag"
},
"tuesday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenDinsdag"
},
"wednesday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 4,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenWoensdag"
},
"thursday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 7.5,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenDonderdag"
},
"friday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 4,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenVrijdag"
},
"saturday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenZaterdag"
},
"sunday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenZondag"
}
}
},
"evenWeeks": {
"type": "object",
"properties": {
"monday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenMaandag"
},
"tuesday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenDinsdag"
},
"wednesday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenWoensdag"
},
"thursday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenDonderdag"
},
"friday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 2,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenVrijdag"
},
"saturday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenZaterdag"
},
"sunday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenZondag"
}
}
}
}
}
}
},
"wage": {
"type": [
"object",
"null"
],
"properties": {
"grossWage": {
"type": [
"number",
"null"
],
"format": "double",
"example": 23,
"description": "The gross wage for the employee\n",
"minimum": 1,
"maximum": 1000000,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Basisloon",
"x-loket-implementation": "In het geval van een 0 NULL teruggeven"
},
"grossWageType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates whether the `grossWage` is an hourly wage or a periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in wagePeriodType.\n",
"x-loket-implementation": "In het geval dat grossWage NULL is dit veld ook op NULL stellen",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.BasisloonEenheid"
},
"value": {
"type": "string",
"example": "hourly",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisloonEenheid"
}
}
},
"netWage": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Net wage for the employment\n",
"minimum": 1,
"maximum": 1000000,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Nettoloon",
"x-loket-implementation": "In het geval van een 0 NULL teruggeven"
},
"netWageType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates whether the net wage is an hourly wage or a periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in the payroll administration resource.\n",
"x-loket-implementation": "In het geval dat netWage NULL is dit veld ook op NULL stellen",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "loket.ConceptWerknemer.NettoloonEenheid"
},
"value": {
"type": "string",
"example": "hourly",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisloonEenheid"
}
}
},
"payScale": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "A pay scale (also known as a salary structure) is a system that determines how much an employee is to be paid as a wage or salary, based on one or more factors such as the employee\"s level, rank or status within the employer\"s organization, the length of time that the employee has been employed, and the difficulty of the specific work performed. After selecting a pay scale a pay grade needs to be selected to determine the actual wage. Only works with `grossWage`. The value of `grossWage` will be updated server side after the submit.\n\n`payScale` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "loket.Beloning.Salarisschaal"
},
"value": {
"type": "string",
"example": "Glastuinbouw maand, Loongebouw A",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Ulsa.Salarisschaal",
"x-loket-implementation": "Dit veld is ADM specifiek en bij het ophalen moet ook gekeken worden naar welke waardes voor de administratie beschikbaar zijn."
}
}
},
"payGrade": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The pay grade indicates on what level (cel) of the paygrade the employment is. The level is multi dimensional where the description indicates both the level and for example the number of years of service within the given level. \n\n`payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "loket.Beloning.SalarisschaalCelID"
},
"value": {
"type": "string",
"example": "Schaal B1, 15 jaar",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "ulsa.SalarisschaalCel",
"x-loket-implementation": "Dit veld is ADM specifiek en bij het ophalen moet ook gekeken worden naar welke waardes voor de administratie beschikbaar zijn."
}
}
},
"applyPayGrade": {
"type": [
"boolean",
"null"
],
"readOnly": false,
"example": true,
"description": "Apply pay grade indicates that after submitting the record the server will replace the value of `grossWage` with the value represented by the selected `payGrade`. A pay grade contains time based values, the value that is active on the `start date` of the record will be selected. \n",
"x-loket-implementation": "De GUI past de salarisschaal cel alleen toe als de waarde van salarisschaal, schaalcel of toepassen salarisschaal gewijzigd wordt. Met de API willen we dat als applyPayGrade op true staat het basisloon altijd voor overschreven met de waarde van paygrade. De waarde die geselecteerd moet worden is de waarde die actief is op de start datum van de belonings regel.",
"x-loket-db-field": "loket.Beloning.SalarisschaalToepassen"
}
}
},
"organizationalEntity": {
"type": [
"object",
"null"
],
"properties": {
"function": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The function of the employment.\n\n`function` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.FunctieID en dan in loket.functie het externId ophalen"
},
"description": {
"type": "string",
"example": "Directeur",
"readOnly": true,
"x-loket-db-field": "Loket.Functie.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.Functie bevat de functies voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
},
"group": {
"type": "string",
"example": "internal",
"readOnly": true,
"x-loket-db-field": "Loket.Functie.functiegroup",
"x-loket-implementation": "Let op: de tabel Loket.Functie bevat de functies voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
},
"deviatingFunctionGroup": {
"type": [
"string",
"null"
],
"example": "9A",
"description": "The deviating functiongroup description of the employment.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Functiegroep"
},
"deviatingFunctionDescription": {
"type": [
"string",
"null"
],
"example": "Directeur",
"description": "The deviating function description of the employment. This description deviates from the value of the `function` field.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Functieomschrijving"
},
"standardFunction": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The standard (cao)function of the employment.\n\n`standardFunction` is a metadata field within the payroll administration context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.StandaardFunctieID"
},
"value": {
"type": "string",
"example": "Administrateur",
"readOnly": true,
"x-loket-db-field": "Ulsa.Standaardfunctie.Omschrijving",
"x-loket-implementation": "Let op: de tabel Ulsa.StandaardFunctie bevat de standaard functies voor alle werkgevers,loonmodellen en cao's. Filteren op (ulsa) werkgever is dus noodzakelijk."
},
"code": {
"type": [
"string",
"null"
],
"example": "A21",
"minLength": 1,
"maxLength": 6,
"readOnly": true,
"x-loket-db-field": "Ulsa.Standaardfunctie.code",
"x-loket-implementation": "Let op: de tabel Ulsa.StandaardFunctie bevat de standaard functies voor alle werkgevers,loonmodellen en cao's. Filteren op (ulsa) werkgever is dus noodzakelijk."
},
"category": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "loket.Standaardfunctie.categorie"
}
}
},
"department": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The department of the employment.\n\n`department` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Afdeling omzetten naar guid"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.Afdeling.code"
},
"description": {
"type": "string",
"example": "Verkoop",
"readOnly": true,
"x-loket-db-field": "Loket.Afdeling.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.Afdeling bevat de afdelingen voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
},
"distributionUnit": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Distribution unit, used in several reports and the \"basic wage journal\" functionality. Commonly used as a cost center. \n\n`distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user. \n",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "Loket.VerdelingsEenheid.ExternId"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.nummer"
},
"description": {
"type": "string",
"example": "Sales",
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.Omschrijving"
}
}
},
"placeOfEmployment": {
"type": [
"string",
"null"
],
"example": "Amsterdam office",
"description": "The place of employment (standplaats) for the employment.",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Standplaats"
},
"internalTelephoneExtensionNumber": {
"type": [
"string",
"null"
],
"example": "0133031600",
"description": "The phone extention number for the employment.",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.InternTelefoonnummer"
}
}
},
"socialSecurity": {
"type": [
"object",
"null"
],
"properties": {
"isInsuredForSicknessBenefitsAct": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Will contributions for the Sickness Benefits Act (ZW) be payed for this employment",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.VerzekerdZW",
"x-loket-translation": "https://www.belastingdienst.nl/wps/wcm/connect/bldcontenten/belastingdienst/business/payroll_taxes/you_are_not_established_in_the_netherlands_are_you_required_to_withhold_payroll_taxes/when_you_are_going_to_withhold_payroll_taxes/calculating_payroll_taxes/calculating_employed_persons_insurance_contributions/own-risk_bearer_for_employed_persons_insurance_schemes"
},
"isInsuredForUnemploymentInsuranceAct": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Will contributions for the Unemployment Insurance Act (WW) be payed for this employment",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.VerzekerdWW",
"x-loket-translation": "https://www.belastingdienst.nl/wps/wcm/connect/bldcontenten/belastingdienst/business/payroll_taxes/you_are_not_established_in_the_netherlands_are_you_required_to_withhold_payroll_taxes/when_you_are_going_to_withhold_payroll_taxes/calculating_payroll_taxes/uniform_wage_concept_for_payroll_taxes"
},
"isInsuredForOccupationalDisabilityInsuranceAct": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Will contributions for the Occupational Disability Insurance Act (WAO) be payed for this employment",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.VerzekerdWAO",
"x-loket-translation": "https://www.belastingdienst.nl/wps/wcm/connect/bldcontenten/belastingdienst/business/payroll_taxes/you_are_not_established_in_the_netherlands_are_you_required_to_withhold_payroll_taxes/when_you_are_going_to_withhold_payroll_taxes/calculating_payroll_taxes/calculating_employed_persons_insurance_contributions/calculating_employed_persons_insurance_contributions"
},
"healthCareInsuranceActType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates what type of Health Care Insurance Act (Zvw) is applicable for this employment",
"x-loket-translation": "https://www.belastingdienst.nl/wps/wcm/connect/bldcontenten/belastingdienst/business/payroll_taxes/you_are_not_established_in_the_netherlands_are_you_required_to_withhold_payroll_taxes/when_you_are_going_to_withhold_payroll_taxes/calculating_payroll_taxes/calculating_the_income-dependent_contribution_pursuant_to_the_health_care_insurance_act_zvw",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.SoortZvw"
},
"value": {
"type": "string",
"example": "(C/K) Wel verzekeringsplichtig, normaal tarief",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortZvw"
}
}
}
}
},
"fiscal": {
"type": [
"object",
"null"
],
"properties": {
"annualSalary": {
"type": [
"number",
"null"
],
"format": "double",
"example": 60000,
"description": "The fiscal annual salary",
"minimum": 0,
"maximum": 1000000000,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Jaarloon"
},
"deviatingPayrollTaxTableColour": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates if there is a deviating payroll tax table is applicable (green vs white table)",
"x-loket-comment": "Indicatie of een afwijkende kleur loonheffingentabel moet worden toegepast. De default is in de inrichting van de salarisadministratie opgenomen.",
"x-loket-implementation": "als NULL dan 0 voor database",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.AfwijkendeKleurLB"
},
"value": {
"type": "string",
"example": "Werknemer belastingpl. en niet premiepl. WLZ",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctKleurLoonbelastingtabel"
}
}
},
"applyDayTables": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Indicates whether the value of the day table is used for the calculation of payroll tax",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.DagtabelToepassen"
},
"deviatingPayrollTaxPercentage": {
"type": [
"number",
"null"
],
"format": "double",
"example": 27.45,
"description": "Indicates a deviating payroll tax percentage is to be applied",
"readOnly": true,
"x-loket-db-field": "Loket.ConceptWerknemer.AfwijkendLB_Percentage"
},
"applyDeviatingPayrollTaxPercentageOn": {
"type": "object",
"format": "metadata",
"description": "Indicates on what type of payroll calculation the deviating payroll tax percentage is applicable",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.AfwijkendPercentageToepassen"
},
"value": {
"type": "string",
"example": "Afwijkend voor tabel- en tariefloon",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLoonbelastingPercentage"
}
}
},
"applyPayrollTaxDeduction": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Indicates whether payroll tax deduction is appliclable (loonheffingskorting)",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Loonheffingskorting"
},
"applyStudentDeduction": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Apply the \"Scholierenregeling\"",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Scholierenregeling"
},
"deviatingCalculationRulePayrollTax": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates if, while calculating payroll taxes and social security contributions, certain deviations are applicable. NL; Herleidingsregel",
"x-loket-comment": "https://www.belastingdienst.nl/wps/wcm/connect/bldcontentnl/themaoverstijgend/brochures_en_publicaties/herleidingsregels_april_2016",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Herleidingsregel"
},
"value": {
"type": "string",
"example": "Werknemer belastingpl. en niet premiepl. WLZ",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortLoonbelastingtabel"
}
}
},
"residentOf": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.InwonerVan"
},
"value": {
"type": "string",
"example": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden",
"description": "Description of the type of document",
"maxLength": 80,
"readOnly": true,
"x-loket-db-field": "dbo.ctInwonerVan.Omschrijving"
}
}
}
}
},
"otherPayrollVariables": {
"type": [
"object",
"null"
],
"properties": {
"deviatingPremiumGroup": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.PremiegroepWachtgeld"
},
"value": {
"type": "string",
"example": "(12) Metaal- en technische bedrijfstakken",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctPremiegroepWachtgeld"
}
}
}
}
},
"selfService": {
"type": "object",
"readOnly": true,
"properties": {
"status": {
"type": "string",
"description": "Description of the status",
"maxLength": 50,
"readOnly": true,
"enum": [
"HasAccessToClient",
"NoAccessToClient",
"UserIsBlocked",
"AccessToClientIsBlocked",
"InvitePending",
"InviteFailed",
"InviteCancelled",
"InviteExpired"
]
},
"clientName": {
"type": "string",
"description": "The name of the Client\n",
"example": "ESS",
"readOnly": true
}
}
},
"employee2024-11-13": {
"type": "object",
"properties": {
"employeeData": {
"$ref": "#/components/schemas/employee"
},
"employmentData": {
"$ref": "#/components/schemas/employment"
},
"workingHoursData": {
"$ref": "#/components/schemas/workingHours"
},
"wageData": {
"$ref": "#/components/schemas/wage"
},
"organizationalEntityData": {
"$ref": "#/components/schemas/organizationalEntity"
},
"socialSecurityData": {
"$ref": "#/components/schemas/socialSecurity"
},
"fiscalData": {
"$ref": "#/components/schemas/fiscal"
},
"otherPayrollVariablesData": {
"$ref": "#/components/schemas/otherPayrollVariables"
},
"selfService": {
"$ref": "#/components/schemas/selfService"
},
"citizenServiceNumber": {
"$ref": "#/components/schemas/citizenServiceNumber-2"
}
}
},
"revokeEmployeeSelfServiceAccess": {
"properties": {
"revokeEmployeeSelfServiceAccessOn": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The date on which the Employees access to ESS (werknemer.loket) will be automatically revoked.\n",
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.DatumBlokkerenWerknemerLoket"
}
}
},
"employeeCustomField": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"customField": {
"type": "object",
"format": "metadata",
"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).\n",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of the custom field as defined at the employer level",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
"readOnly": false
},
"description": {
"type": "string",
"example": "Shoe size",
"maxLength": 50,
"readOnly": true
}
}
},
"value": {
"type": "string",
"maxLength": 255,
"example": "41",
"description": "The value for the custom field for the employee",
"readOnly": false
}
}
},
"employeeCustomFieldPost": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"customField": {
"type": "object",
"format": "metadata",
"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).\n",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of the custom field as defined at the employer level",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
"readOnly": false
},
"description": {
"type": "string",
"example": "Shoe size",
"maxLength": 50,
"readOnly": true
}
}
},
"value": {
"type": "string",
"maxLength": 255,
"example": "41",
"description": "The value for the custom field for the employee",
"readOnly": false
}
}
},
"employerNumber": {
"type": "integer",
"format": "int32",
"example": 20720,
"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).",
"readOnly": true,
"x-loket-db-field": "Loket.Werkgever.WerkgeverId"
},
"companyName": {
"type": "string",
"example": "Voorbeeld B.V.",
"description": "Name of the company",
"maxLength": 70,
"readOnly": false
},
"chamberOfCommerceNumber": {
"type": [
"string",
"null"
],
"example": "18124676",
"description": "Chamber of commerce number. In Dutch \"Kamer van koophandel\" number",
"maxLength": 35,
"readOnly": false
},
"employerLogo": {
"type": [
"string",
"null"
],
"format": "url",
"example": "https://api.loket.nl/v2/v2/providers/employers/{guid}/logo/{version}",
"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.",
"readOnly": true
},
"providerLogo": {
"type": [
"string",
"null"
],
"format": "url",
"example": "https://api.loket.nl/v2/v2/providers/employers/{guid}/deviatingproviderlogo",
"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)",
"readOnly": true
},
"sbi": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The 'Standard Industrial Classifications (Dutch SBI 2008, NACE and ISIC)' as defined bij the Dutch chamber of commerce",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 12,
"description": "The key of the SBI code. Possible values can be aquired via the metadata endpoint",
"readOnly": false
},
"value": {
"type": "string",
"example": "Agriculture, Forestry and Fishing",
"description": "Description of the SBI code",
"readOnly": true,
"maxLength": 255,
"x-loket-db-field": "dbo.ctSbi"
},
"sbiCode": {
"type": "string",
"example": "0116",
"description": "Possible values are the values from the Dutch SBI 2008",
"readOnly": true,
"maxLength": 32
}
}
},
"legalForm": {
"type": [
"object",
"null"
],
"format": "metadata",
"x-loket-implementation": "0 in database wordt NULL in resource",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the legal form. Possible values can be aquired via the metadata endpoint",
"readOnly": false
},
"value": {
"type": "string",
"example": "B.V.",
"description": "Description of the legal form. Possible values are the legel forms supported by Dutch law",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctrechtsvorm"
}
}
},
"branch": {
"type": [
"object",
"null"
],
"format": "metadata",
"x-loket-implementation": "0 in database wordt NULL in resource",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The key of the branch. Possible values can be aquired via the metadata endpoint",
"readOnly": false
},
"value": {
"type": "string",
"example": "Landbouw en jacht",
"description": "Description of the branch. Branch is only available in Dutch",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBranche"
}
}
},
"providerSettings": {
"type": "object",
"properties": {
"administrationNumber": {
"type": [
"string",
"null"
],
"example": "SR2",
"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.",
"maxLength": 15,
"readOnly": false
},
"groupCode": {
"format": "int32",
"type": [
"integer",
"null"
],
"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).\n\nThis field does not support 0 as a value. If 0 is send it will be stored as NULL.",
"x-loket-implementation": "0 in database wordt NULL in resource",
"example": 40,
"readOnly": false
},
"parentEmployerForConsolidatedOverviews": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 9933,
"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.",
"readOnly": false
},
"sendEmailWhenSalarySlipIsAvailable": {
"type": "boolean",
"example": true,
"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\")",
"readOnly": false
}
}
},
"contact-2": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"type": [
"string",
"null"
],
"example": "Henk de Vries",
"description": "Name of the contact of the employer",
"maxLength": 50,
"readOnly": false
},
"phoneNumber": {
"type": [
"string",
"null"
],
"example": "013-12345678",
"description": "The general phone number of the employer",
"maxLength": 15,
"readOnly": false
},
"function": {
"type": [
"string",
"null"
],
"example": "Manager",
"description": "The job title/function of the contact of the employer",
"maxLength": 50,
"readOnly": false
}
}
},
"contactInformation-3": {
"type": [
"object",
"null"
],
"properties": {
"emailAddress": {
"type": [
"string",
"null"
],
"format": "email",
"example": "info@voorbeeldbv.nl",
"description": "The email address of the employer",
"maxLength": 255,
"readOnly": false
},
"faxNumber": {
"type": [
"string",
"null"
],
"example": "(088) 31 11149",
"description": "The fax number of the employer",
"maxLength": 15,
"readOnly": false
},
"phoneNumber": {
"type": [
"string",
"null"
],
"example": "(088) 31 11150",
"description": "The telephone number of the employer",
"maxLength": 15,
"readOnly": false
},
"website": {
"type": [
"string",
"null"
],
"format": "url",
"example": "www.voorbeeldbv.nl",
"description": "The website of the employer",
"maxLength": 255,
"readOnly": false
}
}
},
"employer": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"employerNumber": {
"$ref": "#/components/schemas/employerNumber"
},
"companyName": {
"$ref": "#/components/schemas/companyName"
},
"chamberOfCommerceNumber": {
"$ref": "#/components/schemas/chamberOfCommerceNumber"
},
"employerLogo": {
"$ref": "#/components/schemas/employerLogo"
},
"providerLogo": {
"$ref": "#/components/schemas/providerLogo"
},
"sbi": {
"$ref": "#/components/schemas/sbi"
},
"legalForm": {
"$ref": "#/components/schemas/legalForm"
},
"branch": {
"$ref": "#/components/schemas/branch"
},
"providerSettings": {
"$ref": "#/components/schemas/providerSettings"
},
"contact": {
"$ref": "#/components/schemas/contact-2"
},
"contactInformation": {
"$ref": "#/components/schemas/contactInformation-3"
},
"address": {
"$ref": "#/components/schemas/address"
},
"deviatingPostalAddress": {
"$ref": "#/components/schemas/deviatingPostalAddress"
}
}
}
]
},
"street": {
"type": "string",
"example": "Voordijk",
"description": "Streetname of the address",
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "Straatnaam"
},
"houseNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"description": "House number of the address",
"readOnly": false,
"x-loket-db-field": "Huisnummer"
},
"postalCode": {
"type": "string",
"example": "1234AA",
"description": "The postal code of the address",
"maxLength": 9,
"readOnly": false,
"x-loket-db-field": "Postcode"
},
"city": {
"type": "string",
"example": "Leiden",
"maxLength": 24,
"description": "City of the address",
"readOnly": false,
"x-loket-db-field": "Plaatsnaam"
},
"addressCompact": {
"allOf": [
{
"type": "object",
"properties": {
"street": {
"$ref": "#/components/schemas/street"
},
"houseNumber": {
"$ref": "#/components/schemas/houseNumber"
},
"postalCode": {
"$ref": "#/components/schemas/postalCode"
},
"city": {
"$ref": "#/components/schemas/city"
}
}
}
]
},
"administrationNumber-2": {
"type": [
"string",
"null"
],
"example": "SR2",
"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.",
"maxLength": 15,
"readOnly": false
},
"groupCode-2": {
"format": "int32",
"type": [
"integer",
"null"
],
"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).\n\nThis field does not support 0 as a value. If 0 is send it will be stored as NULL.",
"x-loket-implementation": "0 in database wordt NULL in resource",
"example": 40,
"readOnly": false
},
"providerSettingsCompact": {
"type": "object",
"properties": {
"administrationNumber": {
"$ref": "#/components/schemas/administrationNumber-2"
},
"groupCode": {
"$ref": "#/components/schemas/groupCode-2"
}
}
},
"phoneNumber-2": {
"type": [
"string",
"null"
],
"example": "(088) 31 11150",
"description": "The telephone number of the employer",
"maxLength": 15,
"readOnly": false
},
"contactInformationCompact": {
"type": "object",
"properties": {
"phoneNumber": {
"$ref": "#/components/schemas/phoneNumber-2"
}
}
},
"name-3": {
"type": [
"string",
"null"
],
"example": "Henk de Vries",
"description": "Name of the contact of the employer",
"maxLength": 50,
"readOnly": false
},
"phoneNumber-3": {
"type": [
"string",
"null"
],
"example": "013-12345678",
"description": "The general phone number of the employer",
"maxLength": 15,
"readOnly": false
},
"contactCompact": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/name-3"
},
"phoneNumber": {
"$ref": "#/components/schemas/phoneNumber-3"
}
}
},
"employerMinimized": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"companyName": {
"$ref": "#/components/schemas/companyName"
},
"address": {
"$ref": "#/components/schemas/addressCompact"
},
"providerSettings": {
"$ref": "#/components/schemas/providerSettingsCompact"
},
"contactInformation": {
"$ref": "#/components/schemas/contactInformationCompact"
},
"contact": {
"$ref": "#/components/schemas/contactCompact"
},
"employerLogo": {
"$ref": "#/components/schemas/employerLogo"
},
"providerLogo": {
"$ref": "#/components/schemas/providerLogo"
},
"branch": {
"$ref": "#/components/schemas/branch"
},
"employerNumber": {
"$ref": "#/components/schemas/employerNumber"
}
}
}
]
},
"informationForWizard": {
"type": "object",
"properties": {
"isAuthorizedToManageEmployerAuthorizationGroups": {
"type": "boolean",
"description": "true if the loged in user is authorized to manage which authorization groups (teams) an employer is linked to.",
"readOnly": true
},
"isAuthorizedToManageEmployerModules": {
"type": "boolean",
"description": "true if the loged in user is authorized to manage which moduels (producten) an employer is linked to.",
"readOnly": true
},
"isAuthorizedToAddPayrollAdministrations": {
"type": "boolean",
"description": "true if the loged in user is authorized to add payroll administrations (verloning/administratie) to the employer.",
"readOnly": true
}
}
},
"parentEmployerForConsolidatedOverviews": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 9933,
"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.",
"readOnly": false
},
"childEmployer": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"employerNumber": {
"$ref": "#/components/schemas/employerNumber"
},
"companyName": {
"$ref": "#/components/schemas/companyName"
},
"providerSettings": {
"type": "object",
"properties": {
"parentEmployerForConsolidatedOverviews": {
"$ref": "#/components/schemas/parentEmployerForConsolidatedOverviews"
}
}
}
}
}
]
},
"function": {
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID).\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true,
"x-loket-db-field": "loket.functie.externId"
},
"description": {
"type": "string",
"example": "Directeur",
"readOnly": false,
"maxLength": 50,
"x-loket-db-field": "Loket.Functie.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.Functie bevat de functies voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
},
"group": {
"type": [
"string",
"null"
],
"example": "Var",
"readOnly": false,
"maxLength": 5,
"x-loket-db-field": "Loket.Functie.functiegroup",
"x-loket-implementation": "Let op: de tabel Loket.Functie bevat de functies voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
},
"id-2": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"description": "The visible identifier of the department.\n",
"x-loket-db-field": "Loket.Afdeling.Nummer"
},
"description-3": {
"type": "string",
"example": "Verkoop Binnendienst",
"readOnly": false,
"maxLength": 50,
"description": "The visible description (i.e. name) of the department.\n",
"x-loket-db-field": "Loket.Afdeling.Omschrijving"
},
"subDepartmentOf": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "If the department is a sub department (i.e. underlying) of another department, then the key-field of that other department may be entered here.\n",
"x-loket-db-field": "Loket.Afdeling.OnderdeelVanAfdelingID. Let op ! AfdelingId (niet het Nummer) van die afdeling",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "Loket.Afdeling.OnderdeelVanAfdelingID omzetten naar guid"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.Afdeling.Nummer"
},
"description": {
"type": "string",
"example": "Verkoop Algemeen",
"readOnly": true,
"maxLength": 50,
"x-loket-db-field": "Loket.Afdeling.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.Afdeling bevat de afdelingen voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
},
"emailLeaveRequest": {
"type": [
"string",
"null"
],
"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,
"x-loket-implementation": "indien leeg of spaties > NULL voor database",
"x-loket-db-field": "Loket.Dienstverband.EmailVerlofaanvraag",
"readOnly": false
},
"archive": {
"type": "object",
"description": "Archive status for the department.",
"properties": {
"isArchived": {
"type": "boolean",
"example": false,
"description": "Derived by this logic: IsArchived = ArchivedDate <= CurrentDate.\n",
"readOnly": true
},
"archivedDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": null,
"readOnly": true
}
}
},
"departmentGetPostObject": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id-2"
},
"code": {
"$ref": "#/components/schemas/code"
},
"description": {
"$ref": "#/components/schemas/description-3"
},
"subDepartmentOf": {
"$ref": "#/components/schemas/subDepartmentOf"
},
"emailLeaveRequest": {
"$ref": "#/components/schemas/emailLeaveRequest"
},
"archive": {
"$ref": "#/components/schemas/archive"
}
}
},
"departmentPutObject": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id-2"
},
"description": {
"$ref": "#/components/schemas/description-3"
},
"subDepartmentOf": {
"$ref": "#/components/schemas/subDepartmentOf"
},
"emailLeaveRequest": {
"$ref": "#/components/schemas/emailLeaveRequest"
}
}
},
"dashboard": {
"type": "object",
"properties": {
"dashboardLocation": {
"type": [
"string",
"null"
],
"format": "url",
"example": "http://qlik01.loket.nl/loket-api/sense/app/00000000-0000-0000-0000-000000000000/sheet/00000000-0000-0000-0000-000000000000/state/analysis?qlikTicket=0000000000000000",
"description": "The location of the Qlik employer dashboard.",
"readOnly": true
}
}
},
"customField": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"maxLength": 50,
"example": "Shoe size",
"description": "The description for the custom field which can be used at the employee and employment level",
"readOnly": false
}
}
},
"educationType": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"code": {
"type": "string",
"minLength": 1,
"maxLength": 10,
"example": "WO",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"description": "An unique code for the eduction type within the scope of the employer",
"readOnly": false
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"example": "Wetenschappelijk onderwijs",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"description": "The description of the education type",
"readOnly": false
}
}
},
"educationFurtherIndication": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"code": {
"type": "string",
"minLength": 1,
"maxLength": 10,
"example": "lts",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"description": "An unique code for the eduction further indication within the scope of the employer",
"readOnly": false
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"example": "Lagere technische school",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"description": "The description of the education furhter indication",
"readOnly": false
}
}
},
"contractCode": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"code": {
"type": "integer",
"format": "int32",
"example": 1022,
"description": "An unique code for the contract code within the scope of the employer",
"readOnly": false
},
"description": {
"type": "string",
"maxLength": 50,
"example": "Special contract",
"description": "The description of the contract code",
"readOnly": false
}
}
},
"benefitInKindType": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"example": "Laptop",
"pattern": "^[\\s\\S]*\\S[\\s\\S]*$",
"description": "The description of the benifit in kind type",
"readOnly": false
}
}
},
"customHoliday": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"date": {
"type": "string",
"format": "date",
"example": "2021-01-01",
"description": "The date for the custom holiday.",
"readOnly": false
},
"description": {
"type": "string",
"maxLength": 50,
"example": "Company 100th year anniversary",
"description": "The description for the custom holiday.",
"readOnly": false
}
}
},
"billableItemEmployerObject": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"providerId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"employer": {
"type": "object",
"description": "Data about the employer.\n",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"companyName": {
"type": "string",
"example": "Janssen B.V.",
"readOnly": true
}
}
},
"requestedDate": {
"type": "string",
"format": "date",
"example": "2022-04-12",
"readOnly": true,
"description": "The date on which the billable item is requested.\n"
},
"requestedBy": {
"type": "object",
"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.\n",
"properties": {
"user": {
"type": [
"object",
"null"
],
"description": "Data on who has requested the billable item. \n",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name of the user",
"maxLength": 28,
"minLength": 1,
"readOnly": true
},
"initials": {
"type": "string",
"example": "S.L.",
"description": "The initials of the user",
"maxLength": 6,
"minLength": 1,
"readOnly": true
},
"prefix": {
"type": [
"string",
"null"
],
"example": "van",
"description": "The prefix of the user",
"maxLength": 10,
"minLength": 1,
"readOnly": true
},
"lastName": {
"type": "string",
"example": "Bergen",
"description": "The last name of the user",
"maxLength": 25,
"minLength": 1,
"readOnly": true
},
"formattedName": {
"type": "string",
"example": "Wiel - van Bergen S.L. van de",
"description": "Formatted name of the user.",
"maxLength": 82,
"readOnly": true
}
}
},
"name": {
"type": [
"string",
"null"
],
"example": "B. Janssen",
"readOnly": true,
"description": "The name of the user\n"
}
}
},
"issuedTo": {
"type": "object",
"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.\n",
"properties": {
"person": {
"type": [
"object",
"null"
],
"description": "Information on the person to whom the billable item was issued to. \n",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name, given name, forename or Christian name as part of a persons personal name.\n",
"minLength": 1,
"maxLength": 28,
"readOnly": false
},
"lastName": {
"type": "string",
"example": "Bergen",
"description": "The last name, family name or surname as part of a persons personal name.\n",
"minLength": 1,
"maxLength": 25,
"readOnly": false
},
"prefix": {
"type": [
"string",
"null"
],
"example": "van",
"description": "The prefix to the last name\n",
"minLength": 1,
"maxLength": 10,
"readOnly": false
},
"initials": {
"type": "string",
"example": "S.L.",
"description": "The initials\n",
"minLength": 1,
"maxLength": 6,
"readOnly": false
},
"lastNamePartner": {
"type": [
"string",
"null"
],
"example": "Wiel",
"description": "The last name of the employee's partner.",
"maxLength": 25,
"readOnly": true
},
"prefixPartner": {
"type": [
"string",
"null"
],
"example": "van de",
"description": "The prefix to the last name of the employee's partner.",
"maxLength": 10,
"readOnly": true
},
"formattedName": {
"type": "string",
"example": "Wiel - van Bergen S.L. van de",
"description": "Formatted name of the employee based on the value of `howToFormatLastName`",
"maxLength": 82,
"readOnly": true
}
}
},
"name": {
"type": "string",
"example": "B. Janssen",
"readOnly": false,
"maxLength": 50
}
}
},
"requestedItem": {
"type": "object",
"description": "Details on the requested item.\n",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"itemType": {
"type": "object",
"description": "Details on the requested item.\n",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The item type of the billed item."
},
"description": {
"type": "string",
"example": "Preboarding traject",
"description": "The description of the item type."
}
}
},
"preboardingTrajectory": {
"type": [
"object",
"null"
],
"readOnly": true,
"description": "This object contains item type specific data\n",
"properties": {
"status": {
"type": "string",
"enum": [
"open",
"completed",
"endedPrematurely"
],
"description": "The status of the preboardingTraject.\n",
"example": "open",
"readOnly": true
},
"dateLastModification": {
"type": "string",
"format": "date",
"example": "2022-04-12",
"description": "The date on which the status was last modified",
"readOnly": true
}
}
}
}
}
}
},
"nationalHoliday": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"nationalHoliday": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "The default configuration of the national holiday.\n\nIf the deviations object is set those values overwrite all the default values.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the national holiday. This value is used in the `nationalHoliday` metadata object to refer to this configuration (and the possible deviations)\n",
"readOnly": true
},
"value": {
"type": "string",
"example": "2e kerstdag",
"maxLength": 50,
"description": "The description for the national holiday.\n",
"readOnly": true
},
"enabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the national holiday is used to calculate leave hours for a leave request\n",
"readOnly": true
},
"dateInCurrentYear": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2021-12-26",
"description": "The date for the national holiday in the current year.\n",
"readOnly": true
}
}
},
"deviations": {
"type": [
"object",
"null"
],
"readOnly": false,
"description": "Optional deviations to the national holiday.\nIf set these deviations will overwrite the default values.",
"properties": {
"value": {
"type": "string",
"example": "Boxing day",
"description": "The description for the national holiday.\n",
"maxLength": 50,
"readOnly": false
},
"enabled": {
"type": "boolean",
"example": true,
"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.\n",
"readOnly": false
}
}
}
}
},
"configurationObject": {
"properties": {
"deviatingProviderLogo": {
"type": [
"object",
"null"
],
"description": "The deviating provider logo. When provided, this logo will be used as providerlogo instead of the default providerlogo.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"attribute": {
"type": "string",
"example": "Logo 1",
"description": "the attribute of the logo.",
"maxLength": 10,
"readOnly": true
},
"name": {
"type": "string",
"example": "EmployerLogo",
"description": "The name of the logo.",
"maxLength": 50,
"readOnly": true
}
}
}
}
},
"description-4": {
"type": "string",
"example": "Sales",
"maxLength": 50,
"readOnly": false
},
"distributionUnitGetPostObject": {
"type": "object",
"description": "Distribution unit, used in several reports and the \"basic wage journal\" functionality. Commonly used as a cost center.\n",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false
},
"description": {
"$ref": "#/components/schemas/description-4"
}
}
},
"distributionUnitPutObject": {
"type": "object",
"description": "Distribution unit, used in several reports and the \"basic wage journal\" functionality. Commonly used as a cost center.\n",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true
},
"description": {
"$ref": "#/components/schemas/description-4"
}
}
},
"yearTransitionPatch": {
"properties": {
"sentEssMail": {
"type": "boolean",
"description": "Property that indicates if an email will be sent to the employees.",
"readOnly": false
},
"dateAvailableEss": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2025-04-01",
"description": "The date on which the employee can access the yearendstatement.",
"readOnly": false
}
}
},
"yearTransitionCollective": {
"properties": {
"payrollAdministrationId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"sentEssMail": {
"type": "boolean",
"description": "Property that indicates if an email will be sent to the employees.",
"readOnly": false
},
"dateAvailableEss": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2025-04-01",
"description": "The date on which the employee can access the yearendstatement.",
"readOnly": false
}
}
},
"essAccessConceptEmployee": {
"type": "object",
"properties": {
"conceptEmployee": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 156,
"description": "The employee number to uniquely identify a employee within an employer.",
"readOnly": true
},
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name of the employee",
"maxLength": 28,
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.Roepnaam"
},
"initials": {
"type": "string",
"example": "S.L.",
"description": "The initials of the employee",
"maxLength": 6,
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.Voorletters"
},
"prefix": {
"type": [
"string",
"null"
],
"example": "van",
"description": "The prefix of the employee",
"maxLength": 10,
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.Voorvoegsel"
},
"lastName": {
"type": "string",
"example": "Bergen",
"description": "The last name of the employee",
"maxLength": 25,
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.Achternaam"
},
"emailAddress": {
"type": [
"string",
"null"
],
"example": "info@loket.nl",
"description": "The e-mail address of the employee.",
"maxLength": 255,
"readOnly": false
},
"formattedName": {
"type": "string",
"example": "Wiel - van Bergen S.L. van de",
"description": "Formatted name of the employee based on the value of `howToFormatLastName`",
"maxLength": 82,
"readOnly": true,
"x-loket-implementation": "payrolladministrations"
}
}
},
"status": {
"type": "string",
"description": "Description of the status",
"maxLength": 50,
"readOnly": true,
"enum": [
"HasAccessToClient",
"NoAccessToClient",
"UserIsBlocked",
"AccessToClientIsBlocked"
]
}
}
},
"essAccess": {
"type": "object",
"properties": {
"employee": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 156,
"description": "The employee number to uniquely identify a employee within an employer.",
"readOnly": true
},
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name of the employee",
"maxLength": 28,
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.Roepnaam"
},
"initials": {
"type": "string",
"example": "S.L.",
"description": "The initials of the employee",
"maxLength": 6,
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.Voorletters"
},
"prefix": {
"type": [
"string",
"null"
],
"example": "van",
"description": "The prefix of the employee",
"maxLength": 10,
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.Voorvoegsel"
},
"lastName": {
"type": "string",
"example": "Bergen",
"description": "The last name of the employee",
"maxLength": 25,
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.Achternaam"
},
"emailAddress": {
"type": [
"string",
"null"
],
"example": "info@loket.nl",
"description": "The e-mail address of the employee.",
"maxLength": 255,
"readOnly": false
},
"formattedName": {
"type": "string",
"example": "Wiel - van Bergen S.L. van de",
"description": "Formatted name of the employee based on the value of `howToFormatLastName`",
"maxLength": 82,
"readOnly": true,
"x-loket-implementation": "payrolladministrations"
}
}
},
"hasTwoFactorAuthentication": {
"type": "boolean",
"example": false,
"description": "Does the employee have two factor authentication enabled",
"readOnly": true
},
"status": {
"type": "string",
"description": "Description of the status",
"maxLength": 50,
"readOnly": true,
"enum": [
"HasAccessToClient",
"NoAccessToClient",
"UserIsBlocked",
"AccessToClientIsBlocked",
"InvitePending",
"InviteFailed",
"InviteCancelled",
"InviteExpired"
]
}
}
},
"employeeSelfServicePatch": {
"type": "array",
"items": {
"properties": {
"employeeId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"action": {
"type": "string",
"description": "The action to be taken for the given employee",
"maxLength": 50,
"readOnly": false,
"enum": [
"SendInvite",
"RevokeInvite",
"RevokeAccess",
"ReinstateAccess",
"ResendUsername",
"DisableTwoFactorAuthentication"
]
}
}
}
},
"essAccessMigration": {
"type": "object",
"properties": {
"employee": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"formattedName": {
"type": "string",
"example": "Wiel - van Bergen S.L. van de",
"description": "Formatted name of the employee based on the value of `howToFormatLastName`",
"maxLength": 82,
"readOnly": true
},
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name of the employee",
"maxLength": 28,
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.Roepnaam"
},
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 156,
"description": "The employee number to uniquely identify a employee within an employer.",
"readOnly": true
},
"emailAddress": {
"type": [
"string",
"null"
],
"example": "info@loket.nl",
"description": "The e-mail address of the employee.",
"maxLength": 255,
"readOnly": false
},
"employmentEndDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The date on which the employment ends.",
"readOnly": true,
"x-loket-db-field": "Loket.Dienstverband.DatumUitDienst"
}
}
},
"statusWNL": {
"type": "string",
"description": "Description of the status",
"maxLength": 50,
"readOnly": true,
"enum": [
"HasAccessToClient"
]
},
"statusESS": {
"type": "string",
"description": "Description of the status",
"maxLength": 50,
"readOnly": true,
"enum": [
"NoAccessToClient",
"UserIsBlocked",
"AccessToClientIsBlocked",
"InviteFailed",
"InviteCancelled",
"InviteExpired"
]
}
}
},
"userInformation": {
"type": "object",
"properties": {
"userName": {
"type": [
"string",
"null"
],
"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])))$",
"example": "info@loket.nl",
"description": "The username of the user.",
"maxLength": 255,
"readOnly": false
},
"emailAddress": {
"type": [
"string",
"null"
],
"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])))$",
"example": "info@loket.nl",
"description": "The e-mail address of the user.",
"maxLength": 255,
"readOnly": false
}
}
},
"essAccessClever": {
"type": "object",
"properties": {
"employeeId": {
"$ref": "#/components/schemas/id"
},
"status": {
"type": "string",
"description": "Description of the status",
"maxLength": 50,
"readOnly": true,
"enum": [
"HasAccessToClient",
"NoAccessToClient",
"UserIsBlocked",
"AccessToClientIsBlocked",
"InvitePending",
"InviteFailed",
"InviteCancelled",
"InviteExpired"
]
}
}
},
"employeeSelfServicePatchClever": {
"type": "array",
"items": {
"properties": {
"employeeId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"action": {
"type": "string",
"description": "The action to be taken for the given employee",
"maxLength": 50,
"readOnly": false,
"enum": [
"SendInvite",
"RevokeAccess",
"ReinstateAccess"
]
}
}
}
},
"payrollPeriod": {
"type": "object",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"example": 2026
},
"periodNumber": {
"type": "integer",
"format": "int32",
"example": 1
},
"periodStartDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2026-01-01"
},
"periodEndDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2026-01-31"
}
}
},
"payrollResultsComparison": {
"type": "object",
"properties": {
"description": {
"type": "string",
"example": "Net wage"
},
"value": {
"type": "number",
"format": "decimal",
"example": 2500
},
"subcategories": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/payrollResultsComparison"
}
}
}
},
"payrollPeriodResultComparison": {
"type": "object",
"properties": {
"payrollPeriod": {
"$ref": "#/components/schemas/payrollPeriod"
},
"payrollResultsComparison": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payrollResultsComparison"
}
}
}
},
"wageProjectionCustomiseInput": {
"type": "object",
"properties": {
"currentHoursPerWeek": {
"type": [
"number",
"null"
],
"minimum": 1,
"maximum": 99.99,
"example": 36
},
"deviations": {
"type": [
"object",
"null"
],
"description": "When provided, at least one of `grossWageChangePercentage` or `hoursPerWeek` must have a value.",
"properties": {
"grossWageChangePercentage": {
"type": [
"number",
"null"
],
"minimum": 0.01,
"maximum": 99.99,
"example": 5
},
"hoursPerWeek": {
"type": [
"number",
"null"
],
"minimum": 1,
"maximum": 99.99,
"example": 32
}
}
},
"calculateUsingNextYearsValues": {
"type": [
"boolean",
"null"
],
"default": false,
"example": false,
"description": "If true, projection uses next year's tax and wage values."
}
}
},
"wageProjectionPerInterval": {
"type": "object",
"properties": {
"current": {
"type": "number",
"format": "decimal",
"example": 2500
},
"afterChange": {
"type": "number",
"format": "decimal",
"example": 2625
}
}
},
"wageProjectionComparisonResult": {
"type": "object",
"properties": {
"netWagePerPeriod": {
"$ref": "#/components/schemas/wageProjectionPerInterval"
},
"grossWagePerYear": {
"$ref": "#/components/schemas/wageProjectionPerInterval"
}
}
},
"wageProjectionByCollectiveLaborAgreementInput": {
"type": "object",
"properties": {
"collectiveLaborAgreementId": {
"type": [
"string",
"null"
],
"format": "uuid",
"example": "0d6dd4fb-892e-4e75-9b0d-0d7770e0f51e"
},
"grossWage": {
"type": "number",
"format": "double",
"minimum": 0.01,
"maximum": 999999.99,
"example": 3500,
"description": "The gross wage per payroll period."
},
"hoursPerWeek": {
"type": "number",
"format": "double",
"minimum": 0.01,
"maximum": 99.99,
"example": 24.5,
"description": "The hours per week used in the wage calculation."
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1995-05-21"
},
"holidayAllowance": {
"type": [
"object",
"null"
],
"properties": {
"percentage": {
"type": "number",
"minimum": 0,
"maximum": 999.999999,
"example": 8
},
"resultPayrollComponent": {
"type": [
"object",
"null"
],
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 82
}
}
}
}
},
"additionalPayrollPeriod": {
"type": [
"object",
"null"
],
"properties": {
"percentage": {
"type": "number",
"minimum": 0,
"maximum": 999.999999,
"example": 8
},
"resultPayrollComponent": {
"type": [
"object",
"null"
],
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 83
}
}
}
}
},
"applyPayrollTaxDeduction": {
"type": [
"boolean",
"null"
],
"example": false
},
"companyCar": {
"type": [
"object",
"null"
],
"properties": {
"fiscalAddition": {
"type": "number",
"minimum": 0.01,
"maximum": 999999.99,
"example": 345.87
},
"fiscalAdditionPeriod": {
"type": "string",
"enum": [
"Year",
"PayrollPeriod"
]
}
}
},
"deductions": {
"type": [
"object",
"null"
],
"properties": {
"net": {
"type": [
"number",
"null"
],
"minimum": 0.01,
"maximum": 999999.99,
"example": 50.87
},
"gross": {
"type": [
"number",
"null"
],
"minimum": 0.01,
"maximum": 999999.99,
"example": 50.87
}
}
},
"payments": {
"type": [
"object",
"null"
],
"properties": {
"net": {
"type": [
"number",
"null"
],
"minimum": 0.01,
"maximum": 999999.99,
"example": 50.87
},
"gross": {
"type": [
"number",
"null"
],
"minimum": 0.01,
"maximum": 999999.99,
"example": 50.87
}
}
},
"deviations": {
"type": [
"object",
"null"
],
"description": "When provided, at least one of `grossWagePercentageChange` or `hoursPerWeek` must have a value.",
"properties": {
"grossWagePercentageChange": {
"type": [
"number",
"null"
],
"minimum": 0.01,
"maximum": 99.99,
"example": 25
},
"hoursPerWeek": {
"type": [
"number",
"null"
],
"minimum": 1,
"maximum": 99.99,
"example": 37.5
}
}
},
"calculateUsingNextYearsValues": {
"type": [
"boolean",
"null"
],
"default": false,
"example": true,
"description": "If true, projection uses next year's tax and wage values."
}
}
},
"bundle": {
"type": "object",
"description": "A bundle indicates what mijn loket subscription level (bundle) the module belongs to. It contains the id and description of the bundle.\n",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"description": {
"type": "string",
"example": "Plus",
"readOnly": true,
"maxLength": 50
}
}
},
"modules": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"description": {
"type": "string",
"example": "Personeelsregistratie",
"readOnly": true,
"maxLength": 50
},
"number": {
"type": "number",
"format": "int32",
"description": "the module number",
"example": 40,
"readOnly": true
},
"bundle": {
"$ref": "#/components/schemas/bundle"
}
}
},
"modulesPatch": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of the module\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"action": {
"type": "string",
"enum": [
"enable",
"disable"
],
"description": "The action to perform.",
"readOnly": false
}
}
},
"conceptEmployee2018-01-01": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id",
"x-loket-comment": "LET OP; voor een concept employment betreft dit het veld \"Gereserveerd persoon GUID\""
},
"uniqueName": {
"type": "string",
"example": "Sollicitant 013",
"minLength": 1,
"maxLength": 255,
"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.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.UniekeNaam"
},
"creationDate": {
"type": "string",
"format": "date-time",
"example": "2018-05-08",
"description": "The date time on which the record was added (ISO-8601)",
"readOnly": true,
"x-loket-db-field": "loket.ConceptWerknemer.DatumAanmaak"
},
"employeeData": {
"$ref": "#/components/schemas/employee"
},
"employmentData": {
"$ref": "#/components/schemas/employment"
},
"workingHoursData": {
"$ref": "#/components/schemas/workingHours"
},
"wageData": {
"$ref": "#/components/schemas/wage"
},
"organizationalEntityData": {
"$ref": "#/components/schemas/organizationalEntity"
},
"socialSecurityData": {
"$ref": "#/components/schemas/socialSecurity"
},
"fiscalData": {
"$ref": "#/components/schemas/fiscal"
},
"otherPayrollVariablesData": {
"$ref": "#/components/schemas/otherPayrollVariables"
},
"selfService": {
"$ref": "#/components/schemas/selfService"
},
"conceptEmployeeStatus": {
"type": "string",
"description": "Description of the status",
"maxLength": 50,
"readOnly": true,
"enum": [
"HasAccessToClient",
"NoAccessToClient",
"UserIsBlocked",
"AccessToClientIsBlocked",
"InvitePending",
"InviteFailed",
"InviteCancelled",
"InviteExpired",
"Done"
]
}
}
},
"conceptEmployeeMinimized": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id",
"x-loket-comment": "LET OP; voor een concept employment betreft dit het veld \"Gereserveerd persoon GUID\""
},
"personalDetails": {
"type": "object",
"description": "The personal details of the employee. e.g. Name, civil status en gender",
"properties": {
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name of the employee.",
"maxLength": 28,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Roepnaam"
},
"lastName": {
"type": "string",
"example": "Bergen",
"description": "The last name of the employee.",
"maxLength": 25,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Geboortenaam"
},
"prefix": {
"type": [
"string",
"null"
],
"example": "van",
"description": "The prefix to the last name of the employee.",
"maxLength": 10,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Voorvoegsel"
},
"initials": {
"type": [
"string",
"null"
],
"example": "S.L.",
"description": "The initials of the employee.",
"maxLength": 6,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Voorletters"
},
"formattedName": {
"type": [
"string",
"null"
],
"example": "Wiel - van Bergen S.L. van de",
"description": "Formatted name of the employee based on the value of `howToFormatLastName`",
"maxLength": 82,
"readOnly": true,
"x-loket-implementation": "Dit veld is een samenvoegsel van de losse naam elementen. De logica voor het opbouwen van de naam is gelijk aan de logica in Loket.vwVolledigeNaam"
},
"lastNamePartner": {
"type": [
"string",
"null"
],
"example": "Wiel",
"description": "The last name of the employee`s partner.",
"maxLength": 25,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.AchternaamPartner"
},
"prefixPartner": {
"type": [
"string",
"null"
],
"example": "van de",
"description": "The prefix to the last name of the employee\"s partner.",
"maxLength": 10,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.PartnerVoorvoegsel"
},
"dateOfBirth": {
"type": [
"string",
"null"
],
"format": "date",
"example": "1995-05-21",
"description": "The date of birth of the employee.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Geboortedatum"
},
"placeOfBirth": {
"type": [
"string",
"null"
],
"example": "Amsterdam",
"description": "Place of birth of the employee",
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Geboorteplaats"
},
"howToFormatLastName": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates how the system will format `formattedName`. ",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.GebruikAchternaam"
},
"value": {
"type": "string",
"example": "last name + last name partner",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctGebruikAchternaam.Omschrijving"
}
}
},
"title": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The title to be used (if any).",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Titulatuur"
},
"value": {
"type": "string",
"example": "e.g. Msc, PHD or Baron",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctTitulatuur.Omschrijving"
}
}
},
"gender": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The gender of the employee",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Geslacht"
},
"value": {
"type": "string",
"example": "female",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctGeslacht.Omschrijving"
}
}
},
"nationality": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The nationality of the employee",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Nationaliteit"
},
"value": {
"type": "string",
"example": "Dutch",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctNationaliteit.Omschrijving"
}
}
},
"civilStatus": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The civil status of the employee",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.BurgelijkeStaat"
},
"value": {
"type": "string",
"example": "Married",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBurgelijkeStaat.Omschrijving"
}
}
}
}
},
"contactInformation": {
"type": [
"object",
"null"
],
"description": "Contact information for the employee",
"properties": {
"phoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 13-1234567",
"description": "The phone number of the employee.",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Telefoon"
},
"mobilePhoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 6-1231456",
"description": "The mobile phone number of the employee.",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Mobiel"
},
"faxNumber": {
"type": [
"string",
"null"
],
"example": "+31 13-1234561",
"description": "The fax number to contact this individual",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Fax"
},
"emailAddress": {
"type": [
"string",
"null"
],
"example": "info@loket.nl",
"description": "The e-mail address of the employee.",
"maxLength": 255,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Email"
}
}
},
"identityDocument": {
"type": [
"object",
"null"
],
"description": "The identification document of the employee",
"properties": {
"typeOfDocument": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The key for the type of document. Possible values can be acquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.SoortIdentificatieDocument"
},
"value": {
"type": "string",
"example": "Passport",
"description": "Description of the type of document",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctIdentificatieDocument.Omschrijving"
}
}
},
"documentIdentification": {
"type": [
"string",
"null"
],
"example": "CRE45553433",
"description": "Description of the type of document",
"maxLength": 20,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.NummerIdentificatieDocument"
}
}
},
"address": {
"type": [
"object",
"null"
],
"description": "The address of the employee",
"properties": {
"street": {
"type": [
"string",
"null"
],
"example": "Voordijk",
"description": "Streetname of the address",
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Straatnaam"
},
"city": {
"type": [
"string",
"null"
],
"example": "Leiden",
"maxLength": 24,
"description": "City of the address",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Plaatsnaam"
},
"houseNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 12,
"description": "House number of the address",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Huisnummer"
},
"houseNumberAddition": {
"type": [
"string",
"null"
],
"example": "D",
"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.",
"maxLength": 4,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Huisnummertoevoeging"
},
"furtherIndication": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Futher indication of the address for example onboard (a ship) or living in a trailer",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.NadereAanduiding"
},
"value": {
"type": "string",
"example": "WW",
"readOnly": true,
"x-loket-db-field": "dbo.ctNadereAanduiding.Omschrijving"
}
}
},
"postalCode": {
"type": [
"string",
"null"
],
"example": "1234 AA",
"description": "The postal code of the address",
"maxLength": 9,
"readOnly": false,
"x-loket-db-field": "Postcode"
},
"location": {
"type": [
"string",
"null"
],
"example": "Fourth floor or building C",
"description": "The location like to further specify the address",
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "Locatie"
},
"country": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The country of residence of the employee",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Land"
},
"value": {
"type": "string",
"example": "Netherlands",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.Omschrijving"
},
"isoCode": {
"type": "string",
"example": "NL",
"maxLength": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.IsoCode"
}
}
}
}
},
"iban": {
"type": [
"string",
"null"
],
"example": "NL52ABNA0424968264",
"description": "International Bank Account Number. Only IBAN without spaces are accepted.",
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "Loket.Conceptwerknemer.IBAN"
},
"applyPayrollTaxDeduction": {
"type": "boolean",
"example": true,
"description": "Indicates whether payroll tax deduction is appliclable (loonheffingskorting)",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Loonheffingskorting"
}
}
},
"initiateNewHireChecklist": {
"type": "object",
"properties": {
"comment": {
"type": [
"string",
"null"
],
"example": "New hire checklist initiated for onboarding.",
"description": "An optional comment for when starting the workflow for a new employee.",
"maxLength": 1000,
"readOnly": false
}
}
},
"conceptEmployeeActiveWorkflow": {
"type": "object",
"properties": {
"hasActiveWorkflow": {
"type": "boolean",
"example": true,
"description": "Indicates whether an active new hire checklist workflow exists for the concept employee.",
"readOnly": true
}
}
},
"payGrade": {
"type": "array",
"items": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "Start date of the record.\n",
"readOnly": false
},
"value": {
"type": "number",
"format": "double",
"example": 1153.1,
"description": "Resulting amount for given paygrade"
}
}
}
},
"Fragments": {
"type": [
"string",
"null"
],
"description": "JSON string containing the fragments the conceptemployee should provide in the preboarding flow",
"example": "[\n \"idBewijs\",\n \"persoonsGegevens\"\n]\n",
"readOnly": false
},
"PreboardingTrajectory": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"status": {
"type": "string",
"enum": [
"open",
"completed",
"endedPrematurely"
],
"description": "The status of the preboarding trajectory.\n",
"example": "open",
"readOnly": true
},
"dateLastModification": {
"type": "string",
"format": "date",
"example": "2022-04-12",
"description": "The date on which the status was last modified",
"readOnly": true
},
"clientName": {
"type": "string",
"description": "The name of the Client\n",
"example": "ESS",
"readOnly": true
},
"fragments": {
"$ref": "#/components/schemas/Fragments"
}
}
},
"PostPreboardingTrajectory": {
"type": "object",
"properties": {
"fragments": {
"$ref": "#/components/schemas/Fragments"
}
}
},
"PatchPreboardingTrajectory": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"markAsCompleted",
"markAsEndedPrematurely"
],
"description": "The action to perform on PreboardingTrajectory",
"readOnly": false
}
},
"required": [
"action"
]
},
"payGradeAmounts": {
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"payScale": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "A pay scale (also known as a salary structure) is a system that determines how much an employee is to be paid as a wage or salary, based on one or more factors such as the employee's level, rank or status within the employer's organization, the length of time that the employee has been employed, and the difficulty of the specific work performed. After selecting a pay scale a pay grade needs to be selected to determine the actual wage. Only works with `grossWage`. The value of `grossWage` will be updated server side after the submit.\n\n`payScale` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "loket.Beloning.Salarisschaal"
},
"value": {
"type": "string",
"example": "Glastuinbouw maand, Loongebouw A",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Ulsa.Salarisschaal",
"x-loket-implementation": "Dit veld is ADM specifiek en bij het ophalen moet ook gekeken worden naar welke waardes voor de administratie beschikbaar zijn."
}
}
},
"payGrade": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The pay grade indicates on what level (cel) of the paygrade the employment is. The level is multi dimensional where the description indicates both the level and for example the number of years of service within the given level. \n\n`payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "loket.Beloning.SalarisschaalCelID"
},
"value": {
"type": "string",
"example": "Schaal B1, 15 jaar",
"maxLength": 50,
"readOnly": true
},
"payGradeAmount": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The pay grade indicates on what level (cel) of the paygrade the employment is. The level is multi dimensional where the description indicates both the level and for example the number of years of service within the given level. \n\n`payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.\n",
"properties": {
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "Start date of the record.\n",
"readOnly": false
},
"value": {
"type": "number",
"format": "double",
"example": 1153.1,
"description": "Amount for given paygrade"
}
}
}
}
}
}
},
"assessmentPost": {
"properties": {
"withIq": {
"type": "boolean",
"example": true,
"description": "The type of the assessment",
"readOnly": false
}
}
},
"assessments": {
"properties": {
"requestedBy": {
"type": "object",
"description": "Information about the requestor / initiator.",
"properties": {
"email": {
"type": "string",
"example": "test@test.com",
"description": "The email adresses of the initiator",
"readOnly": true
},
"firstName": {
"type": [
"string",
"null"
],
"example": "Ben",
"description": "The first name of the initiator",
"readOnly": true
},
"lastName": {
"type": [
"string",
"null"
],
"example": "Hur",
"description": "The last name of the initiator",
"readOnly": true
},
"id": {
"$ref": "#/components/schemas/id"
}
}
},
"participant": {
"type": "object",
"description": "Information about the participant.",
"properties": {
"email": {
"type": "string",
"example": "test@test.com",
"description": "The email adresses of the initiator",
"readOnly": true
},
"firstName": {
"type": [
"string",
"null"
],
"example": "Ben",
"description": "The first name of the initiator",
"readOnly": true
},
"lastName": {
"type": [
"string",
"null"
],
"example": "Hur",
"description": "The last name of the initiator",
"readOnly": true
},
"id": {
"$ref": "#/components/schemas/id"
},
"employeeOrConceptEmployee": {
"type": "string",
"enum": [
"employee",
"conceptEmployee",
"notFound"
],
"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."
}
}
},
"status": {
"type": "string",
"enum": [
"sent",
"completed",
"denied",
"shared"
]
},
"invitedDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2022-02-22",
"description": "The date on which the invite for the Assessment was send",
"readOnly": true
},
"resultUrl": {
"type": [
"string",
"null"
],
"example": "https://portal.theselectionlab.com/candidate?email=&user_type=recruiter",
"description": "The url on which the report can be found",
"readOnly": true
}
}
},
"conceptEmployeeContactPersonAddress": {
"type": "object",
"properties": {
"street": {
"type": [
"string",
"null"
],
"example": "Voordijk",
"description": "Streetname of the address",
"maxLength": 100,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptPersoonContact.Straat"
},
"city": {
"type": [
"string",
"null"
],
"example": "Leiden",
"maxLength": 100,
"description": "City of the address",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptPersoonContact.Plaats"
},
"houseNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 12,
"description": "House number of the address",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptPersoonContact.Huisnummer"
},
"houseNumberAddition": {
"type": [
"string",
"null"
],
"example": "D",
"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.",
"maxLength": 10,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptPersoonContact.Huisnummertoevoeging"
},
"postalCode": {
"type": [
"string",
"null"
],
"example": "1234 AB",
"description": "The postal code of the address",
"maxLength": 10,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptPersoonContact.Postcode"
},
"country": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 528,
"description": "The key for the country. Possible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptPersoonContact.LandId"
},
"value": {
"type": "string",
"example": "Netherlands",
"description": "The name of the country",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.Omschrijving"
},
"isoCode": {
"type": "string",
"example": "NL",
"description": "The ISO 3166-1 alpha-2 value for the country",
"maxLength": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.IsoCode"
}
}
}
}
},
"conceptEmployeeContactPerson": {
"type": "object",
"x-loket-db": "De velden zijn te vinden in Loket.ConceptPersoonContact",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"example": "Johanna Bakker",
"description": "Name of the contact person",
"maxLength": 100,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptPersoonContact.Naam"
},
"description": {
"type": "string",
"example": "Moeder",
"description": "Describes the relationship of the contact person to the concept employee",
"maxLength": 50,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptPersoonContact.Kenmerk"
},
"phoneNumber": {
"type": [
"string",
"null"
],
"example": "013-12345678",
"description": "The phone number of the contact person",
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptPersoonContact.Telefoonnummer"
},
"emailAddress": {
"type": [
"string",
"null"
],
"example": "johanna.bakker@example.com",
"description": "The email address of the contact person",
"maxLength": 100,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptPersoonContact.Emailadres"
},
"address": {
"$ref": "#/components/schemas/conceptEmployeeContactPersonAddress"
},
"contactRelationType": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the contact relation type. Possible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptPersoonContact.ContactRelatieTypeId"
},
"value": {
"type": "string",
"example": "Partner",
"description": "The name of the contact relation type",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctContactRelatieType.Omschrijving"
}
}
},
"particularities": {
"type": [
"string",
"null"
],
"example": "Genoemd adres is een priveadres",
"description": "Extra information about the contact person",
"maxLength": 4000,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptPersoonContact.Bijzonderheden"
}
}
},
"metadata": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "",
"description": "The field name of the metadata field\n",
"readOnly": true
},
"options": {
"type": "array",
"readOnly": true,
"items": {
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the metadata field.\n",
"readOnly": false
},
"value": {
"type": "string",
"example": "",
"description": "The description for the metadata field\n",
"readOnly": true
}
}
}
}
}
},
"userBasic": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"initials": {
"type": "string",
"example": "I",
"description": "The initials of the user",
"maxLength": 6,
"readOnly": true,
"x-loket-db-field": "Loket.Gebruiker.Voorletters"
},
"prefix": {
"type": [
"string",
"null"
],
"example": "de",
"description": "The prefix of the user",
"maxLength": 10,
"readOnly": true,
"x-loket-db-field": "Loket.Gebruiker.Voorvoegsel"
},
"lastName": {
"type": "string",
"example": "Jong",
"description": "The last name of the user",
"maxLength": 25,
"readOnly": true,
"x-loket-db-field": "Loket.Gebruiker.Achternaam"
},
"formattedName": {
"type": "string",
"example": "Jong, I",
"description": "preformatted user name for displaying. \\\\\", \\\"\\\\\" \\\"\\",
"readOnly": true
}
}
},
"notification": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"notificationType": {
"type": "object",
"format": "metadata",
"description": "The type of notification",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Loket.Signaal.Soort"
},
"value": {
"type": "string",
"example": "Verjaardag",
"readOnly": true,
"x-loket-db-field": "dbo.ctSignaal.Omschrijving"
}
}
},
"notificationTypeClarification": {
"type": [
"string",
"null"
],
"example": "30 Jaar",
"description": "Optional text",
"maxLength": 150,
"readOnly": true,
"x-loket-db-field": "Loket.Signaal.Melding"
},
"isRead": {
"type": "boolean",
"example": false,
"description": "Indicates whether the notification has been read",
"readOnly": false,
"x-loket-db-field": "Loket.Signaal.Status",
"x-loket-implementation": "In de database is dit een integer die verwijst naar de codetabel dbo.ctSignaalStatus. In de API geven we true terug in het geval van waarde 2 (Gezien) en geven we false terug in het geval van waarde 1 (Tonen)."
},
"notificationDate": {
"type": "string",
"format": "date",
"example": "2018-02-05",
"description": "The date on which the event of the notificationType (e.g. birthday or anniversary) will occure",
"readOnly": true,
"x-loket-db-field": "Loket.Signaal.SignaalDatum"
},
"markedAsReadBy": {
"$ref": "#/components/schemas/userBasic"
},
"markedAsReadOn": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-02-05T12:29:44+02:00",
"description": "The time at which the notificiation was marked as read.",
"readOnly": true,
"x-loket-db-field": "Loket.Signaal.DatumAfgehandeld"
},
"appliesToEmployee": {
"$ref": "#/components/schemas/employeeBasic"
},
"appliesToEmployment": {
"$ref": "#/components/schemas/idNullable"
}
}
},
"employer-2": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"companyName": {
"type": "string",
"example": "Voorbeeld B.V.",
"description": "Name of the company",
"maxLength": 70,
"readOnly": false
},
"employerNumber": {
"type": "integer",
"format": "int32",
"example": 20720,
"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).",
"readOnly": true
},
"administrationNumber": {
"type": [
"string",
"null"
],
"example": "SR2",
"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.",
"maxLength": 15,
"readOnly": false
},
"groupCode": {
"format": "int32",
"type": [
"integer",
"null"
],
"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,
"readOnly": false
}
}
},
"payrollAdministration": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"example": "Voorbeeld B.V. - Payroll",
"description": "The name of the payroll administration. This is the name that is used in the Loket interface.",
"maxLength": 70,
"readOnly": true
},
"shortName": {
"type": [
"string",
"null"
],
"example": "ABC adm",
"description": "Shortened name of the administration",
"maxLength": 12,
"readOnly": false
},
"administrationNumber": {
"type": [
"string",
"null"
],
"example": "SR2",
"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.",
"maxLength": 15,
"readOnly": false
},
"clientNumber": {
"type": "integer",
"format": "int32",
"example": 1234,
"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.",
"readOnly": true,
"x-loket-db-field": "Ulsa.Werkgever.ClientNummer & Loket.Verloning.ClientNr",
"x-loket-implementation": "Het clientnummer is de verbinding tussen Ulsa.Werkgever en Loket.Verloning. Een waarde 0 in de database wordt als NULL teruggegeven in de API."
},
"groupCode": {
"format": "int32",
"type": [
"integer",
"null"
],
"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,
"readOnly": false
},
"groupClassification": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The group classification for the payroll administration. This field is used for filtering and grouping within the interface.\n\n`groupClassification` is a metadata field within the provider context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false,
"x-loket-db-field": "Ulsa.Werkgever.CollectiefGroepID"
},
"value": {
"type": "string",
"example": "South",
"readOnly": true,
"x-loket-db-field": "Ulsa.CollectiefGroep.Omschrijving"
}
}
},
"payrollPeriodType": {
"type": "object",
"readOnly": true,
"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).",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.code"
},
"value": {
"type": "string",
"example": "month",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.Omschrijving"
}
}
},
"cla": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "The CAO (CLA -> collective labor agrement) of the \"loonmodel\" the payroll administration is linked to.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 184,
"readOnly": true,
"x-loket-db-field": "Ulsa.ModelWerkgever.ExternId"
},
"value": {
"type": "string",
"example": "Agriculture",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "ulsa.ModelWerkgever.Omschrijving"
}
}
},
"wagemodel": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "The \"loonmodel\" (this is a Loket term) the payroll administration inherits the payrolling configuration from. Deviating from the loonmodel configuration on payrol administration level is possible.\n\n`loonmodel` is a metadata field within the provider context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 184,
"readOnly": true
},
"value": {
"type": "string",
"example": "Foresting monthly payrolling",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "ulsa.modelwerkgever.naam"
}
}
}
}
},
"nonPayrollAdministration-2": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"example": "Voorbeeld B.V. - Non payroll",
"description": "The name of the non payroll administration. This is the name that is used in the Loket interface.",
"maxLength": 50,
"readOnly": true
}
}
},
"formattedName": {
"type": "string",
"example": "Jong, I",
"description": "preformatted user name for displaying. \\\\\", \\\"\\\\\" \\\"\\",
"readOnly": true
},
"notificationProvider": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"employerId": {
"$ref": "#/components/schemas/id"
},
"employerName": {
"type": "string",
"example": "VST Consultancy",
"description": "Name of the administration",
"maxLength": 70
},
"employerLogo": {
"type": [
"string",
"null"
],
"format": "url",
"example": "https://api.loket.nl/v2/v2/providers/employers/{guid}/logo/{version}",
"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.",
"readOnly": true
},
"employer": {
"$ref": "#/components/schemas/employer-2"
},
"payrollAdministration": {
"$ref": "#/components/schemas/payrollAdministration"
},
"nonPayrollAdministration": {
"$ref": "#/components/schemas/nonPayrollAdministration-2"
},
"notificationType": {
"type": "object",
"format": "metadata",
"description": "The type of notification",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Loket.Signaal.Soort"
},
"value": {
"type": "string",
"example": "Verjaardag",
"readOnly": true,
"x-loket-db-field": "dbo.ctSignaal.Omschrijving"
}
}
},
"notificationTypeClarification": {
"type": [
"string",
"null"
],
"example": "30 Jaar",
"description": "Optional text",
"maxLength": 150,
"readOnly": true,
"x-loket-db-field": "Loket.Signaal.Melding"
},
"isRead": {
"type": "boolean",
"example": false,
"description": "Indicates whether the notification has been read",
"readOnly": false,
"x-loket-db-field": "Loket.Signaal.Status",
"x-loket-implementation": "In de database is dit een integer die verwijst naar de codetabel dbo.ctSignaalStatus. In de API geven we true terug in het geval van waarde 2 (Gezien) en geven we false terug in het geval van waarde 1 (Tonen)."
},
"notificationDate": {
"type": "string",
"format": "date",
"example": "2018-02-05",
"description": "The date on which the event of the notificationType (e.g. birthday or anniversary) will occure",
"readOnly": true,
"x-loket-db-field": "Loket.Signaal.SignaalDatum"
},
"markedAsReadBy": {
"$ref": "#/components/schemas/formattedName"
},
"markedAsReadOn": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-02-05T12:29:44+02:00",
"description": "The time at which the notificiation was marked as read.",
"readOnly": true,
"x-loket-db-field": "Loket.Signaal.DatumAfgehandeld"
},
"appliesToEmployee": {
"type": "object",
"format": "metadata",
"description": "The type of notification",
"properties": {
"formattedName": {
"$ref": "#/components/schemas/formattedName"
},
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 156,
"description": "The employee number to uniquely identify a employee within a employer.",
"readOnly": true
}
}
}
}
},
"notificationPatch": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"action": {
"type": "string",
"enum": [
"markAsRead"
],
"description": "The action to perform on the notification",
"readOnly": false
}
},
"required": [
"id",
"action"
]
},
"notificationSummary": {
"type": "object",
"properties": {
"employerId": {
"$ref": "#/components/schemas/id"
},
"numberOfUnreadNotifications": {
"type": "integer",
"example": 7,
"description": "Number of notifications that are unread and unexpired.",
"readOnly": true
}
}
},
"notificationPatchCollective": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
}
},
"required": [
"id"
]
},
"announcement": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"isRead": {
"type": "boolean",
"example": false,
"description": "Indicates whether the announcement has been read",
"readOnly": false
},
"isExpired": {
"type": "boolean",
"example": false,
"description": "Indicates whether the announcement has expired.",
"readOnly": true
},
"creationDate": {
"type": "string",
"format": "date",
"example": "2018-02-05",
"description": "The date on which the announcement was announced.",
"readOnly": true
},
"effectiveDate": {
"type": "string",
"format": "date",
"example": "2018-02-05",
"description": "The date on which the announcement takes effect",
"readOnly": true
},
"expirationDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-02-05",
"description": "The date on which the announcement expires",
"readOnly": true
},
"subject": {
"type": "string",
"example": "Schaalverhoging",
"description": "subject of the announcement",
"maxLength": 50,
"readOnly": true
},
"description": {
"type": "string",
"example": "Schaal X krijgt een verhoging van Y procent.",
"description": "description of the announcement",
"maxLength": 7500,
"readOnly": true
}
}
},
"announcementProvider": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"employerId": {
"$ref": "#/components/schemas/id"
},
"employerName": {
"type": "string",
"example": "VST Consultancy",
"description": "Name of the administration",
"maxLength": 70
},
"employerLogo": {
"type": [
"string",
"null"
],
"format": "url",
"example": "https://api.loket.nl/v2/v2/providers/employers/{guid}/logo/{version}",
"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.",
"readOnly": true
},
"employer": {
"$ref": "#/components/schemas/employer-2"
},
"payrollAdministration": {
"$ref": "#/components/schemas/payrollAdministration"
},
"isRead": {
"type": "boolean",
"example": false,
"description": "Indicates whether the announcement has been read",
"readOnly": false
},
"isExpired": {
"type": "boolean",
"example": false,
"description": "Indicates whether the announcement has expired.",
"readOnly": true
},
"creationDate": {
"type": "string",
"format": "date",
"example": "2018-02-05",
"description": "The date on which the announcement was announced.",
"readOnly": true
},
"effectiveDate": {
"type": "string",
"format": "date",
"example": "2018-02-05",
"description": "The date on which the announcement takes effect",
"readOnly": true
},
"expirationDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-02-05",
"description": "The date on which the announcement expires",
"readOnly": true
},
"subject": {
"type": "string",
"example": "Schaalverhoging",
"description": "subject of the announcement",
"maxLength": 50,
"readOnly": true
},
"description": {
"type": "string",
"example": "Schaal X krijgt een verhoging van Y procent.",
"description": "description of the announcement",
"maxLength": 7500,
"readOnly": true
}
}
},
"announcementPatch": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"action": {
"type": "string",
"enum": [
"markAsRead"
],
"description": "The action to perform on the announcement",
"readOnly": false
}
},
"required": [
"id",
"action"
]
},
"announcementSummary": {
"type": "object",
"properties": {
"employerId": {
"$ref": "#/components/schemas/id"
},
"numberOfUnreadUnexpiredAnnouncements": {
"type": "integer",
"example": 12,
"description": "Number of announcements that are unread and unexpired.",
"readOnly": true
}
}
},
"announcementPatchCollective": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
}
},
"required": [
"id"
]
},
"announcementProviderDetail": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"employerId": {
"$ref": "#/components/schemas/id"
},
"employerName": {
"type": "string",
"example": "VST Consultancy",
"description": "Name of the administration",
"maxLength": 70
},
"employerLogo": {
"type": [
"string",
"null"
],
"format": "url",
"example": "https://api.loket.nl/v2/v2/providers/employers/{guid}/logo/{version}",
"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.",
"readOnly": true
},
"employer": {
"$ref": "#/components/schemas/employer-2"
},
"payrollAdministration": {
"$ref": "#/components/schemas/payrollAdministration"
},
"isRead": {
"type": "boolean",
"example": false,
"description": "Indicates whether the announcement has been read",
"readOnly": false
},
"isExpired": {
"type": "boolean",
"example": false,
"description": "Indicates whether the announcement has expired.",
"readOnly": true
},
"creationDate": {
"type": "string",
"format": "date",
"example": "2018-02-05",
"description": "The date on which the announcement was announced.",
"readOnly": true
},
"effectiveDate": {
"type": "string",
"format": "date",
"example": "2018-02-05",
"description": "The date on which the announcement takes effect",
"readOnly": true
},
"expirationDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-02-05",
"description": "The date on which the announcement expires",
"readOnly": true
},
"subject": {
"type": "string",
"example": "Schaalverhoging",
"description": "subject of the announcement",
"maxLength": 50,
"readOnly": true
},
"description": {
"type": "string",
"example": "Schaal X krijgt een verhoging van Y procent.",
"description": "description of the announcement",
"maxLength": 7500,
"readOnly": true
}
}
},
"startDate-4": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this employment starts. NL: DatumInDienst",
"readOnly": true,
"x-loket-db-field": "Loket.Dienstverband.DatumInDienst"
},
"historicalStartDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2012-05-01",
"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",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.HistorischeDatumInDienst"
},
"commissionUntilDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2019-01-01",
"description": "The date on which the employment will end. NL: AanstellingTot",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.AanstellingTot"
},
"endDate-5": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The date on which the employment ends. NL: DatumUitDienst",
"readOnly": true,
"x-loket-db-field": "Loket.Dienstverband.DatumUitDienst"
},
"endOfEmploymentReason-2": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The reason for the end of the employment. NL: RedenEindeDienstverband\n\n__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. \nPlease set this field to 8 (Others) unless one of the following integrations is used for this employment\n * UPA-pensioenaangifte\n * Cordares\n * APG-pensioenaangifte\n * Achmea",
"readOnly": true,
"x-loket-implementation": "Indien de waarde 0 (n.v.t) is het element NULL maken.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the reason for the end of the employment.",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.RedenEindeDienstverband"
},
"value": {
"type": "string",
"example": "VUT",
"description": "The description of the reason for the end of the employment.",
"readOnly": true,
"x-loket-db-field": "dbo.ctRedenEindeDienstverband.Omschrijving"
}
}
},
"endOfEmploymentReasonTaxAuthorities-2": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The reason for the end of the employment as specified by the Dutch Tax authorties. NL: RedenEindeDienstverbandAangifte\n\n__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.",
"readOnly": true,
"x-loket-implementation": "Indien de waarde 0 (n.v.t) is het element NULL maken.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the reason for the end of the employment.",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.RedenEindeDienstverbandAangifte"
},
"value": {
"type": "string",
"example": "Beëindiging arbeidsovereenkomst met wederzijds goedvinden op initiatief van de werkgever.",
"description": "The description of the reason for the end of the employment.",
"readOnly": true,
"x-loket-db-field": "dbo.ctRedenEindeDienstverbandAangifte.Omschrijving"
}
}
},
"endOfEmploymentDueToIllness-2": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Indicates whether the reason for the termination of an employment is due to long-term illness. NL: ZiekUitDienst",
"readOnly": true,
"x-loket-db-field": "Loket.Dienstverband.ZiekUitDienst",
"x-loket-implementation": "In de database is dit een non-nullable veld. In de API vertalen we dit alsvolgt: 0 = null, 1 = true, 2 = false"
},
"firstDayNotification": {
"type": [
"boolean",
"null"
],
"example": false,
"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 ",
"readOnly": true,
"x-loket-db-field": "Loket.Dienstverband.EersteDagsMelding",
"x-loket-implementation": "In de database is dit een non-nullable veld. In de API vertalen we dit alsvolgt: 0 = null, 1 = true, 2 = false"
},
"payrollAdministration2019-12-16": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"description": "Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time)\n\n`payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true,
"x-loket-implementation": "Komt uit ulsa.werkgever ipv loket.verloning"
},
"name": {
"type": "string",
"example": "ABC accountants",
"description": "Name of the payroll administration",
"maxLength": 70,
"readOnly": true,
"x-loket-db-field": "Ulsa.Werkgever.Naam --> Dit is anders als wat we nu doen nu komt de naam uit loket.verloning.Omschrijving"
},
"clientNumber": {
"type": "integer",
"format": "int32",
"example": 1234,
"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.",
"readOnly": true,
"x-loket-db-field": "Ulsa.Werkgever.ClientNummer & Loket.Verloning.ClientNr",
"x-loket-implementation": "Het clientnummer is de verbinding tussen Ulsa.Werkgever en Loket.Verloning. Een waarde 0 in de database wordt als NULL teruggegeven in de API."
},
"description": {
"type": "string",
"example": "Bakker",
"description": "Description of the administration",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.Verloning.Omschrijving"
}
}
},
"nonPayrollAdministration2019-12-16": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"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)\n\n`nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true,
"x-loket-implementation": "Komt uit loket.verloning ipv ulsa.werkgever"
},
"name": {
"type": "string",
"example": "HR only employees",
"description": "Name of the non payroll administration",
"maxLength": 70,
"readOnly": true,
"x-loket-db-field": "loket.verloning.Omschrijving"
},
"description": {
"type": "string",
"example": "Bakker",
"description": "Description of the administration",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.Verloning.Omschrijving"
}
}
},
"administration2024-06-26": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"description": "Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time)\n\n`payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"name": {
"type": "string",
"example": "ABC accountants",
"description": "Name of the payroll administration",
"maxLength": 70,
"readOnly": true
},
"clientNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1234,
"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.",
"readOnly": true
},
"description": {
"type": "string",
"example": "Bakker",
"description": "Description of the administration",
"maxLength": 50,
"readOnly": true
},
"administrationType": {
"type": "string",
"enum": [
"payrollAdministration",
"nonPayrollAdministration"
],
"description": "The type of administration",
"readOnly": true
}
}
},
"typeOfEmployee": {
"type": "object",
"format": "metadata",
"description": "A selection of pre defined employee-types for the employment. NL: SoortWerknemer",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.SoortWerknemer"
},
"value": {
"type": "string",
"example": "Werknemer",
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortWerknemer"
}
}
},
"employmentCategoryType": {
"type": "object",
"format": "metadata",
"description": "A selection of special pre defined employment-types for the employment. NL: Type dienstverband",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true
},
"value": {
"type": "string",
"example": "Ouderschapsverlof",
"readOnly": true
}
}
},
"linkedEmployment": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"employmentDurationTypeVerion2019-12-16": {
"type": "object",
"format": "metadata",
"description": "A selection of pre defined durations for the employment. NL: SoortDienstverband",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.SoortDienstverband"
},
"value": {
"type": "string",
"example": "Contract of indefinite duration",
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortDienstverband.Omschrijving"
}
}
},
"startDateContractOfIndefiniteDuration": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-05-08",
"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.",
"readOnly": false
},
"employmentContractType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The type of employment applicable for the employment. NL: BasisDienstverband",
"x-loket-implementation": "Indien de waarde 0 is het element NULL maken.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.BasisDienstverband"
},
"value": {
"type": "string",
"example": "Arbeidsovereenkomst (excl BBL)",
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisDienstverband.Omschrijving"
}
}
},
"vacationCoupons": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indication for vacation coupons (vakantiebonnen). This is only applies to a limited set of CLA`s. NL: Vakantiebonnen",
"x-loket-implementation": "Indien de waarde 0 (n.v.t) is het element NULL maken.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.Vakantiebonnen"
},
"value": {
"type": "string",
"example": "n.v.t.",
"readOnly": true,
"x-loket-db-field": "dbo.ctVakantiebonnen"
}
}
},
"sendToExternalParty": {
"type": [
"object",
"null"
],
"format": "metadata",
"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",
"x-loket-implementation": "Indien de waarde 0 is het element NULL maken.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.AanleveringExternePartij"
},
"value": {
"type": "string",
"example": "n.v.t.",
"readOnly": true,
"x-loket-db-field": "dbo.ctAanleveringExternePartij"
}
}
},
"deviatingCLAExternalParty": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 2,
"description": "CLA (CAO) code in case of a deviating CLA for external parties . NL: CaoKlantgroepAfwijkend",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.CaoKlantgroepAfwijkend",
"x-loket-implementation": "als NULL dan 0 voor database"
},
"deviatingCLATaxReturn": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 2,
"description": "CLA (CAO) code in case of a deviating CLA for tax returns. NL: CAOUWV",
"minimum": 1,
"maximum": 9999,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.CAOUWV",
"x-loket-implementation": "als NULL dan 0 voor database"
},
"incomeRelationshipNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"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",
"minimum": 0,
"maximum": 9999,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.NummerInkomstenVerhouding"
},
"employeeProfileId": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "References to an employeeprofile that is specified in the payroll administration level. NL: WerknemerProfielID\n\n`employeeProfileId` is a metadata field within the payroll administration context. Possible values can be managed by the user.",
"x-loket-implementation": "Let op: moet gefilterd op actieve jaar. Maw alleen profielen voor het actieve moeten worden overgenomen.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.WerknemerProfielID"
},
"value": {
"type": "string",
"example": "Profiel full-timers",
"readOnly": true,
"x-loket-db-field": "Ulsa.Werknemerprofiel.Omschrijving"
}
}
},
"professionCode": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 4,
"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",
"minimum": 1,
"maximum": 999,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.BeroepUWV",
"x-loket-implementation": "als NULL dan 0 voor database"
},
"exemptionWorkRelatedExpenseScheme": {
"type": "boolean",
"example": false,
"description": "Indicates whether an exemption (i.e. non-participation) on the work-related expense scheme (werkkostenregeling) applies for this employment. NL: WerkkostenRegelingUitsluiting",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.WerkkostenRegelingUitsluiting",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"exemptionPremiumWaiverMarginalLabour": {
"type": "boolean",
"example": false,
"description": "Indicates whether an exemption (i.e. waiver) on the premium marginal labour (vrijstelling marginale arbeid) applies for this employment. NL: PremieVrijstellingMarginaleArbeid",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.PremieVrijstellingMarginaleArbeid",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"typeOfParticipation": {
"type": [
"object",
"null"
],
"format": "metadata",
"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",
"x-loket-implementation": "Indien de waarde 0 (n.v.t.) is het element NULL maken.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.AardDeelnemerschap"
},
"value": {
"type": "string",
"example": "n.vt.",
"readOnly": true,
"x-loket-db-field": "dbo.ctAardDeelnemerschap"
}
}
},
"valueOfParticipation": {
"type": [
"object",
"null"
],
"format": "metadata",
"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",
"x-loket-implementation": "als NULL dan 0 voor database",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.WaardeDeelnemerschap"
},
"value": {
"type": "string",
"example": "n.v.t.",
"readOnly": true,
"x-loket-db-field": "dbo.ctWaardeDeelnemerschap"
}
}
},
"wachtgeldOldRegulation": {
"type": "boolean",
"example": false,
"description": "Indicates whether the (old) wachtgeld regulation is applicable for the employment. NL: WachtgeldOudeRegeling",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.WachtgeldOudeRegeling",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"participation55plusRegulationUWV": {
"type": "boolean",
"example": false,
"description": "Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment. NL: Deelname55Plus",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.Deelname55Plus",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"essMutationSet": {
"type": "object",
"format": "metadata",
"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\n\n`essMutationSet` is a metadata field within the werkgever/provider context. Possible values can be managed by the user.",
"readOnly": false,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.ExportsetID"
},
"value": {
"type": "string",
"example": "Standaard",
"readOnly": true,
"x-loket-db-field": "Loket.WerkgeverExportSet & Ulsa.ExportSet",
"x-loket-implementation1": "Waarden komen uit 2 tabellen Loket.WerkgeverExportset (afh. van WerkgeverId+VerloningId) & Ulsa.Exportset (afh. van ProviderId). Als uit Ulsa.Exportset dan id opslaan als negatief getal, als uit WerkgeverExportSet dan id opslaan als positief getal.",
"x-loket-implementation2": "alleen export sets van soort = 1 (algemeen) zijn toegestaan als invoer."
}
}
},
"exemptionInsuranceObligation": {
"type": "object",
"format": "metadata",
"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",
"x-loket-implementation": "De 0 heeft hier een betekenis dus moet teruggegeven worden in de metadata en response",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.CodeUitzondering"
},
"value": {
"type": "string",
"example": "Geen uitzondering.",
"readOnly": true,
"x-loket-db-field": "dbo.ctCodeUitzondering"
}
}
},
"specialIncomeRatio": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates the special income ratio. NL: SpecialeInkomstenVerhouding",
"x-loket-implementation": "als NULL dan 0 voor database",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.SpecialeInkomstenVerhouding"
},
"value": {
"type": "string",
"example": "n.v.t.",
"readOnly": true,
"x-loket-db-field": "dbo.ctSpecialeInkomstenVerhouding.Omschrijving"
}
}
},
"emailLeaveRequest-2": {
"type": [
"string",
"null"
],
"description": "Recipient e-mail adress for notification in case of leave requests. NL: EmailVerlofaanvraag",
"example": "api@loket.nl",
"maxLength": 255,
"x-loket-implementation": "indien leeg of spaties > NULL voor database",
"x-loket-db-field": "Loket.Dienstverband.EmailVerlofaanvraag",
"readOnly": false
},
"temporaryTaxExemption": {
"type": "object",
"format": "metadata",
"description": "Indicates whether there a temporary tax exemption is to be applied for the employment. NL: TijdelijkeHeffingskorting",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.TijdelijkeHeffingskorting"
},
"value": {
"type": "string",
"example": "Nee.",
"readOnly": true,
"x-loket-db-field": "dbo.ctTijdelijkeHeffingskorting"
}
}
},
"periodPayGradeAdjustment": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 2,
"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",
"minimum": 1,
"maximum": 52,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.PeriodeSalarisPeriodiek",
"x-loket-implementation": "als NULL dan 0 voor database"
},
"signalPayGradeAdjustment": {
"type": "boolean",
"example": false,
"description": "Indicates whether signaling regarding salary scale adjustments are enabled for the employment. NL: SalarisschaalSignaleren",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.SalarisschaalSignaleren",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"commissionUntilDate1": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-05-31",
"description": "Until date for commision #1. NL: AanstellingTot1",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.AanstellingTot1"
},
"commissionUntilDate2": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-05-31",
"description": "Until date for commision #2. NL: AanstellingTot2",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.AanstellingTot2"
},
"commissionUntilDate3": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-05-31",
"description": "Until date for commision #3. NL: AanstellingTot3",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.AanstellingTot3"
},
"commissionUntilDate4": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-05-31",
"description": "Until date for commision #4. NL: AanstellingTot4",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.AanstellingTot4"
},
"commissionUntilDate5": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-05-31",
"description": "Until date for commision #5. NL: AanstellingTot5",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.AanstellingTot5"
},
"commissionUntilDate6": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-05-31",
"description": "Until date for commision #6. NL: AanstellingTot6",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.AanstellingTot6"
},
"isDirectorAndMajorShareholder": {
"type": [
"boolean",
"null"
],
"example": false,
"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",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.IsDirecteurGrootAandeelhouder",
"x-loket-implementation": "In de database is dit een non-nullable veld. In de API vertalen we dit alsvolgt: 0 = null, 1 = true, 2 = false"
},
"isPreviousOwner": {
"type": [
"boolean",
"null"
],
"example": false,
"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",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.IsVorigeEigenaar",
"x-loket-implementation": "In de database is dit een non-nullable veld. In de API vertalen we dit alsvolgt: 0 = null, 1 = true, 2 = false"
},
"isFamilyOfOwner": {
"type": [
"boolean",
"null"
],
"example": false,
"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",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.IsFamilieVanEigenaar",
"x-loket-implementation": "In de database is dit een non-nullable veld. In de API vertalen we dit alsvolgt: 0 = null, 1 = true, 2 = false"
},
"isOnCallEmploymentVerion2019-12-16": {
"type": "boolean",
"example": true,
"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\n",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.IsOproepkrachtOfInvalkracht",
"x-loket-implementation": "Voor de WAB is de waarde onbekend weggehaald daarom hebben we dit veld nu non-nullable gemaakt."
},
"hasOnCallAppearanceObligation": {
"type": [
"boolean",
"null"
],
"example": true,
"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\n",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.SoortOproepkrachtOfInvalkracht",
"x-loket-implementation": "In de database correspondeert dit veld met de codetabel ctSoortOproepkrachtOfInvalkracht. In de API maken we dit een nullable boolean met de volgende mapping: 0 = null, 1 = false, 2 = true. LET OP: deze mapping wijkt af van de mappings hierboven die gebaseerd zijn op de codetabel ctOnbekendJaNee."
},
"isGemoedsbezwaardNationalInsurance": {
"type": "boolean",
"example": true,
"description": "Gemoedsbezwaard Volksverzekering. NL: IsGemoedsbezwaardVolksverzekering\n",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.IsGemoedsbezwaardVolksverzekering",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"isGemoedsbezwaardEmployeeInsurance": {
"type": "boolean",
"example": true,
"description": "Gemoedsbezwaard Werknemerverzekering. NL: IsGemoedsbezwaardWerknemerverzekering\n",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.IsGemoedsbezwaardWerknemerverzekering",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"isAnonymousEmployee": {
"type": "boolean",
"example": true,
"description": "An employee that wants to remain anonymous related to social security instances. NL: IsAnoniemeWerknemer\n",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.IsAnoniemeWerknemer",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"cancellationPeriodEmployee": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"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",
"minimum": 1,
"maximum": 1000,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.OpzegtermijnWerknemer",
"x-loket-implementation": "als NULL dan 0 voor database"
},
"cancellationPeriodEmployer": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"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",
"minimum": 1,
"maximum": 1000,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.OpzegtermijnWerkgever",
"x-loket-implementation": "als NULL dan 0 voor database"
},
"cancellationPeriodTimeUnit": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The unit of time used for the noticePeriodeEmployee and noticePeriodEmployer properties. NL: PeriodeOpzegTermijn",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 4,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.PeriodeOpzegTermijn",
"x-loket-implementation": "Indien de waarde 0 (Onbekend) is het element NULL maken."
},
"value": {
"type": "string",
"example": "Maand(en)",
"readOnly": true,
"x-loket-db-field": "dbo.ctPeriode.Omschrijving"
}
}
},
"cancellationNoticeDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-05-31",
"description": "The date on which the notice was given by either the employee or the employer. NL: DatumOpzegging",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.DatumOpzegging"
},
"startCancellationNoticePeriod": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-06-01",
"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",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.AanvangOpzegtermijn"
},
"payrollId": {
"type": "integer",
"format": "int32",
"example": 2,
"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",
"readOnly": true,
"x-loket-db-field": "Loket.Dienstverband.PersoneelsnummerVerloning"
},
"namePayslip": {
"type": [
"string",
"null"
],
"description": "Name that is visible on payslips for the employment. NL: NaamLoonstrook",
"example": "Steve Jobs",
"maxLength": 34,
"readOnly": false,
"x-loket-implementation": "als leeg of spaties > NULL voor de database"
},
"calculateWorkingHours": {
"type": "boolean",
"example": true,
"description": "Automatically calculate working hours for the employment if the option automatically calculate hours is selected for a given period. NL: Completeren/Berekenen uren\n",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.Completeren",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"writtenEmploymentContract": {
"type": "boolean",
"example": true,
"description": "Did the employment and employer make a written contract? NL: Schriftelijke overeenkomst",
"readOnly": false
},
"employment2019-12-16": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"$ref": "#/components/schemas/startDate-4"
},
"historicalStartDate": {
"$ref": "#/components/schemas/historicalStartDate"
},
"commissionUntilDate": {
"$ref": "#/components/schemas/commissionUntilDate"
},
"endDate": {
"$ref": "#/components/schemas/endDate-5"
},
"endOfEmploymentReason": {
"$ref": "#/components/schemas/endOfEmploymentReason-2"
},
"endOfEmploymentReasonTaxAuthorities": {
"$ref": "#/components/schemas/endOfEmploymentReasonTaxAuthorities-2"
},
"endOfEmploymentDueToIllness": {
"$ref": "#/components/schemas/endOfEmploymentDueToIllness-2"
},
"firstDayNotification": {
"$ref": "#/components/schemas/firstDayNotification"
},
"payrollAdministration": {
"$ref": "#/components/schemas/payrollAdministration2019-12-16"
},
"nonPayrollAdministration": {
"$ref": "#/components/schemas/nonPayrollAdministration2019-12-16"
},
"administration": {
"$ref": "#/components/schemas/administration2024-06-26"
},
"typeOfEmployee": {
"$ref": "#/components/schemas/typeOfEmployee"
},
"employmentCategoryType": {
"$ref": "#/components/schemas/employmentCategoryType"
},
"linkedEmployment": {
"$ref": "#/components/schemas/linkedEmployment"
},
"employmentDurationType": {
"$ref": "#/components/schemas/employmentDurationTypeVerion2019-12-16"
},
"startDateContractOfIndefiniteDuration": {
"$ref": "#/components/schemas/startDateContractOfIndefiniteDuration"
},
"employmentContractType": {
"$ref": "#/components/schemas/employmentContractType"
},
"vacationCoupons": {
"$ref": "#/components/schemas/vacationCoupons"
},
"sendToExternalParty": {
"$ref": "#/components/schemas/sendToExternalParty"
},
"deviatingCLAExternalParty": {
"$ref": "#/components/schemas/deviatingCLAExternalParty"
},
"deviatingCLATaxReturn": {
"$ref": "#/components/schemas/deviatingCLATaxReturn"
},
"incomeRelationshipNumber": {
"$ref": "#/components/schemas/incomeRelationshipNumber"
},
"employeeProfileId": {
"$ref": "#/components/schemas/employeeProfileId"
},
"professionCode": {
"$ref": "#/components/schemas/professionCode"
},
"exemptionWorkRelatedExpenseScheme": {
"$ref": "#/components/schemas/exemptionWorkRelatedExpenseScheme"
},
"exemptionPremiumWaiverMarginalLabour": {
"$ref": "#/components/schemas/exemptionPremiumWaiverMarginalLabour"
},
"typeOfParticipation": {
"$ref": "#/components/schemas/typeOfParticipation"
},
"valueOfParticipation": {
"$ref": "#/components/schemas/valueOfParticipation"
},
"wachtgeldOldRegulation": {
"$ref": "#/components/schemas/wachtgeldOldRegulation"
},
"participation55plusRegulationUWV": {
"$ref": "#/components/schemas/participation55plusRegulationUWV"
},
"essMutationSet": {
"$ref": "#/components/schemas/essMutationSet"
},
"exemptionInsuranceObligation": {
"$ref": "#/components/schemas/exemptionInsuranceObligation"
},
"specialIncomeRatio": {
"$ref": "#/components/schemas/specialIncomeRatio"
},
"emailLeaveRequest": {
"$ref": "#/components/schemas/emailLeaveRequest-2"
},
"temporaryTaxExemption": {
"$ref": "#/components/schemas/temporaryTaxExemption"
},
"periodPayGradeAdjustment": {
"$ref": "#/components/schemas/periodPayGradeAdjustment"
},
"signalPayGradeAdjustment": {
"$ref": "#/components/schemas/signalPayGradeAdjustment"
},
"commissionUntilDate1": {
"$ref": "#/components/schemas/commissionUntilDate1"
},
"commissionUntilDate2": {
"$ref": "#/components/schemas/commissionUntilDate2"
},
"commissionUntilDate3": {
"$ref": "#/components/schemas/commissionUntilDate3"
},
"commissionUntilDate4": {
"$ref": "#/components/schemas/commissionUntilDate4"
},
"commissionUntilDate5": {
"$ref": "#/components/schemas/commissionUntilDate5"
},
"commissionUntilDate6": {
"$ref": "#/components/schemas/commissionUntilDate6"
},
"isDirectorAndMajorShareholder": {
"$ref": "#/components/schemas/isDirectorAndMajorShareholder"
},
"isPreviousOwner": {
"$ref": "#/components/schemas/isPreviousOwner"
},
"isFamilyOfOwner": {
"$ref": "#/components/schemas/isFamilyOfOwner"
},
"isOnCallEmployment": {
"$ref": "#/components/schemas/isOnCallEmploymentVerion2019-12-16"
},
"hasOnCallAppearanceObligation": {
"$ref": "#/components/schemas/hasOnCallAppearanceObligation"
},
"isGemoedsbezwaardNationalInsurance": {
"$ref": "#/components/schemas/isGemoedsbezwaardNationalInsurance"
},
"isGemoedsbezwaardEmployeeInsurance": {
"$ref": "#/components/schemas/isGemoedsbezwaardEmployeeInsurance"
},
"isAnonymousEmployee": {
"$ref": "#/components/schemas/isAnonymousEmployee"
},
"cancellationPeriodEmployee": {
"$ref": "#/components/schemas/cancellationPeriodEmployee"
},
"cancellationPeriodEmployer": {
"$ref": "#/components/schemas/cancellationPeriodEmployer"
},
"cancellationPeriodTimeUnit": {
"$ref": "#/components/schemas/cancellationPeriodTimeUnit"
},
"cancellationNoticeDate": {
"$ref": "#/components/schemas/cancellationNoticeDate"
},
"startCancellationNoticePeriod": {
"$ref": "#/components/schemas/startCancellationNoticePeriod"
},
"payrollId": {
"$ref": "#/components/schemas/payrollId"
},
"namePayslip": {
"$ref": "#/components/schemas/namePayslip"
},
"calculateWorkingHours": {
"$ref": "#/components/schemas/calculateWorkingHours"
},
"writtenEmploymentContract": {
"$ref": "#/components/schemas/writtenEmploymentContract"
}
}
},
"employmentResponse2019-12-16": {
"allOf": [
{
"type": "object",
"properties": {
"employee": {
"$ref": "#/components/schemas/employeeBasic"
}
}
},
{
"type": "object",
"$ref": "#/components/schemas/employment2019-12-16"
}
]
},
"employmentMinimizedResponse2019-12-16": {
"allOf": [
{
"type": "object",
"properties": {
"employee": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 156,
"description": "The employee number to uniquely identify a employee within a employer.",
"readOnly": true,
"x-loket-db-field": "Loket.Persoon."
},
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name of the employee",
"maxLength": 28,
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.Roepnaam"
},
"formattedName": {
"type": "string",
"example": "Wiel - van Bergen S.L. van de",
"description": "Formatted name of the employee based on the value of `howToFormatLastName`",
"maxLength": 82,
"readOnly": true,
"x-loket-implementation": "Dit veld is een samenvoegsel van de losse naam elementen. De logica voor het opbouwen van de naam is gelijk aan de logica in Loket.vwVolledigeNaam"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1995-05-21",
"description": "The date of birth\n",
"readOnly": true
},
"photo": {
"type": [
"string",
"null"
],
"format": "url",
"example": "https://api.loket.nl/v2/v2/providers/employers/employees/{employeeId}/photo/{version}",
"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.",
"readOnly": true
},
"fullLastName": {
"type": "string",
"example": "van de Wiel van Bergen",
"description": "The full last name contains the last name of the employee and - if applicable - the partners last name. Both including infixes. Regardless of `howToFormatLastName`"
}
}
}
}
},
{
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"$ref": "#/components/schemas/startDate-4"
},
"commissionUntilDate": {
"$ref": "#/components/schemas/commissionUntilDate"
},
"endDate": {
"$ref": "#/components/schemas/endDate-5"
},
"payrollAdministration": {
"$ref": "#/components/schemas/payrollAdministration2019-12-16"
},
"nonPayrollAdministration": {
"$ref": "#/components/schemas/nonPayrollAdministration2019-12-16"
},
"employmentDurationType": {
"$ref": "#/components/schemas/employmentDurationTypeVerion2019-12-16"
},
"incomeRelationshipNumber": {
"$ref": "#/components/schemas/incomeRelationshipNumber"
},
"payrollId": {
"$ref": "#/components/schemas/payrollId"
}
}
}
]
},
"workinghours": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "Start date of the record.\n\nA (linked chain)[./#section/Data/Date-chains] is maintained within this resource.\n",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.\n",
"readOnly": true
},
"shift": {
"type": "object",
"format": "metaData",
"description": "The shift determines the full-time hours and bonus percentage.\n\n`shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"shiftNumber": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the shift.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.Ploeg.PloegId",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. let wel op dat het ID meerdere malen voor kan komen in ULSa omdat het daar uniek is samen met verlongingsperiodeID"
},
"fullTimeHoursPerWeek": {
"type": "number",
"example": 40,
"description": "The full time hours for an employment that is linked to this shift.\n",
"minimum": 0.01,
"maximum": 99,
"readOnly": true,
"x-loket-db-field": "Ulsa.Ploeg.Uren"
},
"bonusPercentage": {
"type": "number",
"example": 12,
"description": "The bonus percentage used in wage calculations for the hours made in this shift.\n",
"minimum": 0.01,
"maximum": 99,
"readOnly": true,
"x-loket-db-field": "ulsa.ploeg.percentage"
}
}
},
"deviatingHoursPerWeek": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 32,
"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.",
"minimum": 0.01,
"maximum": 99.99,
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.AfwijkendAantalUrenPerWeek",
"x-loket-implementation": "Indien de waarde gelijk is aan 0 een NULL teruggeven",
"x-loket-implementation2": "Minimum 0.01 is zodat er niet numerieke 0 kan worden opgevoerd door de gebruiker van de API",
"x-loket-implementation3": "Indien calculateUsingWorkPattern.deviatingDaysAndHours op true AND enddate=null; dan berekenen dit veld. [som aantal uren in workPattern] /2 , afronden op 2 decimalen"
},
"averageHoursPerWeek": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,2})?$",
"example": 32,
"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.",
"minimum": 0,
"maximum": 168,
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.GemiddeldAantalUrenPerWeek"
},
"deviatingSvDaysPerPeriod": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 20,
"description": "Sv (social insurance) days are normally calculated by hours per shift, this optional field is used to register a deviating value.",
"minimum": 1,
"maximum": 23,
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.AfwijkendAantalDagenPerWeek",
"x-loket-implementation": "Indien de waarde gelijk is aan 0 een NULL teruggeven",
"x-loket-implementation2": "Minimum 1 is zodat er niet numerieke 0 kan worden opgevoerd door de gebruiker van de API",
"x-loket-implementation3": "Indien calculateUsingWorkPattern.deviatingDaysAndHours op true AND endDate=null; dan berekenen dit veld. Indien 4-weken verloning; [aantal velden in workPattern met n uren != 0 ]*2 . Else; [aantal velden in workPattern met n uren != 0 ] * 26 / 12"
},
"averageParttimeFactor": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,4})?$",
"example": 37.5,
"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. \nPlease note that this field is not used in the actual payroll proces! For the payroll process the number of hours is used.",
"minimum": 0.0001,
"maximum": 999.9999,
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.GemiddeldeDeeltijd"
},
"regularWorkPattern": {
"type": "boolean",
"example": true,
"description": "When the employee works the same amount of hours per day every week, then the workpattern is regular.",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.RegelmatigArbeidspatroon"
},
"shiftRateSickLeave": {
"type": "object",
"format": "metadata",
"description": "The shift determines the full-time hours and bonus percentage.\n\n`shiftRateSickLeave` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"shiftNumber": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key number to identify the shift to be used for calculation of daily rate in case of sick leave (ziekte).\n",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.PloegDagloonZW"
},
"fullTimeHoursPerWeek": {
"type": "number",
"example": 40,
"description": "The full time hours for an employment that is linked to this shift.\n",
"minimum": 1,
"maximum": 99,
"readOnly": true,
"x-loket-db-field": "Ulsa.Ploeg.Uren"
},
"bonusPercentage": {
"type": "number",
"example": 12,
"description": "The bonus percentage used in wage calculations for the hours made in this shift.\n",
"minimum": 1,
"maximum": 99,
"readOnly": true,
"x-loket-db-field": "ulsa.ploeg.percentage"
}
}
},
"flexibleHoursContract": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The field indicates the type of flexible contract. If not applicable, please set to NULL.",
"x-loket-implementation": "in db 0 ; in API NULL",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "dbo.ctFlexibelUrenContract.code"
},
"value": {
"type": "string",
"example": "Minimum uren contract",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctFlexibelUrenContract.Omschrijving"
}
}
},
"workPattern": {
"x-loket-implementation1": "Indien object !=null EN tenminste 1 veld heeft niet de numerieke waarde 0; dan record aanmaken/ wijzigen in Loket.WerktijdRooster. Let op; uniek op combinatie werkgever, persoon, dienstverband EN werktijdID.",
"x-loket-implementation2": "Indien object = null ; dan geen nieuw record aanmaken in Loket.WerktijdRooster.",
"x-loket-implementation3": "Let op! Als null wordt opgegeven, dient een eventueel bestaand record in Loket.WerktijdRooster te worden verwijderd.",
"x-loket-comment": "We voegen de volgende validatie toe; 'tenminste 1 van de velden in het workPattern object moet niet gelijk zijn aan 0. Als geen data, zet dan het bovenliggende object op NULL.'",
"type": [
"object",
"null"
],
"description": "The applicable work pattern for a period of 2 weeks can be stored in this object. Each field contains the number of work hours for that day in the 2-week period.
Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0)
Each field represent the number of hours the employee normally works on that day.\n",
"properties": {
"oddWeeks": {
"type": "object",
"properties": {
"monday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenMaandag"
},
"tuesday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenDinsdag"
},
"wednesday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 4,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenWoensdag"
},
"thursday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 7.5,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenDonderdag"
},
"friday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 4,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenVrijdag"
},
"saturday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenZaterdag"
},
"sunday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenZondag"
}
}
},
"evenWeeks": {
"type": "object",
"properties": {
"monday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenMaandag"
},
"tuesday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenDinsdag"
},
"wednesday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenWoensdag"
},
"thursday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenDonderdag"
},
"friday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 2,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenVrijdag"
},
"saturday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenZaterdag"
},
"sunday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenZondag"
}
}
}
}
},
"calculateUsingWorkPattern": {
"type": "object",
"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`\n",
"properties": {
"leaveHours": {
"type": "boolean",
"example": true,
"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\n",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.BerekenenVerlofEenhedenViaRooster"
},
"hoursBrokenPeriod": {
"type": "boolean",
"example": false,
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.BerekenenUrenGebrokenPeriodeViaRooster"
},
"hoursRegularPeriod": {
"type": "boolean",
"example": false,
"description": "Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods.",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.BerekenenUrenPeriodeViaRooster"
},
"daysDailyRate": {
"type": "boolean",
"example": false,
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.DagenDagvergoedingViaRooster"
},
"deviatingDaysAndHours": {
"type": "boolean",
"example": false,
"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)!",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.AfwijkendeDagenUrenViaRooster"
}
}
},
"contractCode": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "This field is specialy made for convenience stores. The field is the type of contract.\n\n`contractCode` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.ContractCodeID omzetten naar GUID vanuit Loket.ContractCode.ExternID"
},
"code": {
"type": "integer",
"format": "int32",
"example": 1022,
"readOnly": true,
"x-loket-db-field": "Loket.ContractCode.Code"
},
"description": {
"type": "string",
"example": "SLA-PT-met toeslagen ATW (88)",
"readOnly": true,
"x-loket-db-field": "Loket.ContractCode.Omschrijving"
}
}
},
"aggregatedHoursPerWeek": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 24,
"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.\nThis 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.",
"minimum": 0.01,
"maximum": 168,
"readOnly": true,
"x-loket-comment": "zie de beschrijving van JIRA issue LWA-7 voor de functionele logica voor de bepaling van dit veld"
}
}
},
"organizationalEntity-2": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The start date of the entity.\n\nA (linked chain)[./#section/Data/Date-chains] is maintained within this resource.",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": true
},
"function": {
"type": "object",
"format": "metadata",
"description": "The function of the employment.\n\n`function` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "loket.WerknemerFunctie.FunctieID en dan in loket.functie het externId ophalen"
},
"description": {
"type": "string",
"example": "Directeur",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.Functie.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.Functie bevat de functies voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
},
"group": {
"type": [
"string",
"null"
],
"example": "internal",
"maxLength": 5,
"readOnly": true,
"x-loket-db-field": "Loket.Functie.functiegroup",
"x-loket-implementation": "Let op: de tabel Loket.Functie bevat de functies voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
},
"deviatingFunctionGroup": {
"type": [
"string",
"null"
],
"example": "9A",
"minLength": 1,
"maxLength": 5,
"description": "The deviating function group description of the employment. Only applies when a deviating function description is defined.",
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerFunctie.Functiegroep"
},
"deviatingFunctionDescription": {
"type": [
"string",
"null"
],
"example": "Directeur",
"description": "The deviating function description of the employment. This description deviates from the value of the `function` field.",
"minLength": 1,
"maxLength": 50,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerFunctie.Functieomschrijving"
},
"standardFunction": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The standard (cao)function of the employment.\n\n`standardFunction` is a metadata field within the payroll administration context. Possible values can be managed by the user.",
"x-loket-implementation": "indien nvt dan NULL",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "loket.WerknemerFunctie.StandaardFunctieID"
},
"value": {
"type": "string",
"example": "Administrateur",
"readOnly": true,
"x-loket-db-field": "Ulsa.Standaardfunctie.Omschrijving",
"x-loket-implementation": "Let op: de tabel Ulsa.StandaardFunctie bevat de standaard functies voor alle werkgevers,loonmodellen en cao's. Filteren op (ulsa) werkgever is dus noodzakelijk."
},
"code": {
"type": [
"string",
"null"
],
"example": "A21",
"minLength": 1,
"maxLength": 6,
"readOnly": true,
"x-loket-db-field": "Ulsa.Standaardfunctie.code",
"x-loket-implementation": "Let op: de tabel Ulsa.StandaardFunctie bevat de standaard functies voor alle werkgevers,loonmodellen en cao's. Filteren op (ulsa) werkgever is dus noodzakelijk."
},
"category": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "loket.Standaardfunctie.categorie"
}
}
},
"department": {
"type": "object",
"format": "metadata",
"description": "The department of the employment.\n\n`department` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "loket.WerknemerFunctie.Afdeling omzetten naar guid"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.Afdeling.Nummer"
},
"description": {
"type": "string",
"example": "Verkoop",
"readOnly": true,
"x-loket-db-field": "Loket.Afdeling.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.Afdeling bevat de afdelingen voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
},
"distributionUnit": {
"type": "object",
"format": "metadata",
"description": "Distribution unit, used in several reports and the \"basic wage journal\" functionality. Commonly used as a cost center.\n\n`distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "Loket.VerdelingsEenheid.ExternId"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.nummer"
},
"description": {
"type": "string",
"example": "Sales",
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.Omschrijving"
}
}
},
"placeOfEmployment": {
"type": [
"string",
"null"
],
"example": "Amsterdam office",
"description": "The standard working location (standplaats) for the employment.",
"minLength": 1,
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerFunctie.Standplaats"
},
"internalTelephoneExtensionNumber": {
"type": [
"string",
"null"
],
"example": "678",
"description": "The phone number of the standard working location (standplaats) for the employment.",
"minLength": 1,
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerFunctie.Telefoon"
}
}
},
"wage-2": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "1995-05-21",
"description": "The start date for the information in the record.\n\nA (linked chain)[./#section/Data/Date-chains] is maintained within this resource.\n__Note__ It is possible to have no wage record.\n",
"readOnly": false,
"x-loket-db-field": "Loket.Beloning.DatumIngang"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The end date for the information in the record.\n",
"readOnly": true,
"x-loket-db-field": "Loket.Beloning.DatumEinde"
},
"payrollPeriodType": {
"type": "object",
"readOnly": true,
"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.\n",
"x-loket-implementation": "De waarde komt uit het actieve jaar van de administratie van het dienstverband. dit kan omdat de waarde functioneel niet aangepast kan worden (technische kan wel maar we staan het niet toe).",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.code"
},
"value": {
"type": "string",
"example": "Maand",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.omschrijving"
}
}
},
"grossWage": {
"type": [
"number",
"null"
],
"format": "double",
"example": 2300,
"description": "The gross wage for the employee\n",
"minimum": 0.01,
"maximum": 999999.99,
"readOnly": false,
"x-loket-db-field": "Loket.Beloning.Basisloon",
"x-loket-implementation": "In het geval van een 0 NULL teruggeven"
},
"grossWageType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates whether the `grossWage` is an hourly wage or a Periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in wagePeriodType.\n",
"x-loket-implementation": "In het geval dat grossWage NULL is dit veld in de GET output ook op NULL stellen. In de PUT of POST als dit veld op NULL staat 1 in de DB opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Beloning.BasisloonEenheid"
},
"value": {
"type": "string",
"example": "hourly",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisloonEenheid"
}
}
},
"isGrossWageFullTime": {
"type": "boolean",
"readOnly": true,
"example": true,
"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 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 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.\n",
"x-loket-implementation": "De waarde komt uit component 70 van de administratie van het dienstverband rekening houden met de ingangsdatum van de belonings regel en het jaar bij de componenten. Start de beloningsregel voor het eerste jaar dat bekend is bij de werkgever pak dan de waarde bij component 70 van het eerste jaar. Ligt het jaartal van de startdatum van de beloningsregel na het laatste bekende jaar bij de administratie. Pak dan de waarde van het laatste jaar van de administratie. In alle andere gevallen pak de inrichting van het jaar van de ingangsdatum van de beloningsregel. Let op: componenten maken gebruik van de ULSA overerving methodiek. Er zal waarschijnlijk een View zijn die de juiste data terug geeft. (vwModelComonent?)",
"x-loket-db-field": "ulsa.component.Fulltime"
},
"netWage": {
"type": [
"number",
"null"
],
"format": "double",
"example": 2400,
"description": "Net wage for the employment\n",
"minimum": 0.01,
"maximum": 999999.99,
"readOnly": false,
"x-loket-db-field": "Loket.Beloning.Nettoloon",
"x-loket-implementation": "In het geval van een 0 NULL teruggeven"
},
"netWageType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates whether the net wage is an hourly wage or a periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in the payroll administration resource.\n",
"x-loket-implementation": "In het geval dat netWage NULL is dit veld in de GET output ook op NULL stellen. In de PUT of POST als dit veld op NULL staat 1 in de DB opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Beloning.NettoloonEenheid"
},
"value": {
"type": "string",
"example": "hourly",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisloonEenheid"
}
}
},
"employerCosts": {
"type": [
"number",
"null"
],
"format": "double",
"description": "The cost for the employer for this employee.\n",
"example": 3500,
"minimum": 0.01,
"maximum": 99999.99,
"readOnly": false,
"x-loket-db-field": "Loket.Beloning.Loonkosten",
"x-loket-implementation": "In het geval van een 0 NULL teruggeven"
},
"employerCostsType": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"x-loket-implementation": "In het geval dat employerCosts NULL is dit veld in de GET output ook op NULL stellen. In de PUT of POST als dit veld op NULL staat 1 in de DB opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Beloning.LoonkostenEenheid"
},
"value": {
"type": "string",
"example": "hourly",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisloonEenheid"
}
}
},
"payScale": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "A pay scale (also known as a salary structure) is a system that determines how much an employee is to be paid as a wage or salary, based on one or more factors such as the employee's level, rank or status within the employer's organization, the length of time that the employee has been employed, and the difficulty of the specific work performed. After selecting a pay scale a pay grade needs to be selected to determine the actual wage. Only works with `grossWage`. The value of `grossWage` will be updated server side after the submit.\n\n`payScale` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "loket.Beloning.Salarisschaal"
},
"value": {
"type": "string",
"example": "Glastuinbouw maand, Loongebouw A",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Ulsa.Salarisschaal",
"x-loket-implementation": "Dit veld is ADM specifiek en bij het ophalen moet ook gekeken worden naar welke waardes voor de administratie beschikbaar zijn."
}
}
},
"payGrade": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The pay grade indicates on what level (cel) of the paygrade the employment is. The level is multi dimensional where the description indicates both the level and for example the number of years of service within the given level. \n\n`payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "loket.Beloning.SalarisschaalCelID"
},
"value": {
"type": "string",
"example": "Schaal B1, 15 jaar",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "ulsa.SalarisschaalCel",
"x-loket-implementation": "Dit veld is ADM specifiek en bij het ophalen moet ook gekeken worden naar welke waardes voor de administratie beschikbaar zijn."
}
}
},
"applyPayGrade": {
"type": [
"boolean",
"null"
],
"readOnly": false,
"example": true,
"description": "Apply pay grade indicates that after submitting the record the server will replace the value of `grossWage` with the value represented by the selected `payGrade`. A pay grade contains time based values, the value that is active on the `start date` of the record will be selected.\n",
"x-loket-implementation": "De GUI past de salarisschaal cel alleen toe als de waarde van salarisschaal, schaalcel of toepassen salarisschaal gewijzigd wordt. Met de API willen we dat als applyPayGrade op true staat het basisloon altijd voor overschreven met de waarde van paygrade. De waarde die geselecteerd moet worden is de waarde die actief is op de start datum van de belonings regel.",
"x-loket-db-field": "loket.Beloning.SalarisschaalToepassen"
}
}
},
"socialSecurityBenefits": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year.\n\nA (broken chain)[./#section/Data/Date-chains] is maintained within this resource.",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false
},
"supplementation": {
"type": "object",
"properties": {
"type": {
"type": "object",
"format": "metadata",
"description": "Indicates whether and how supplementation should be applied. This is used when the employer supplements the pay out percentage.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerSocialeUitkering.Suppleren"
},
"value": {
"type": "string",
"example": "Suppleren (bruto)",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctWijzeSuppleren"
}
}
},
"percentage": {
"type": "number",
"format": "double",
"description": "If supplementation is applied then the supplementation percentage (up to) is registered here.\n",
"example": 35,
"minimum": 0,
"maximum": 100,
"pattern": "^(\\d{1,3})(\\.\\d{1,2})?$",
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerSocialeUitkering.SuppletiePercentage"
}
}
}
}
},
"benefitPostGet": {
"type": "object",
"properties": {
"type": {
"type": "object",
"format": "metadata",
"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.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Loket.WerknemerSocialeUitkering.SoortSocialeUitkering"
},
"value": {
"type": "string",
"example": "ZW eigen risico",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortSocialeUitkering"
}
}
},
"percentage": {
"type": "number",
"format": "double",
"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).\n",
"example": 35,
"minimum": 0,
"maximum": 100,
"pattern": "^(\\d{1,3})(\\.\\d{1,2})?$",
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerSocialeUitkering.LoonkostenUitkeringsPercentage"
}
}
},
"socialSecurityBenefitsPostGet": {
"allOf": [
{
"$ref": "#/components/schemas/socialSecurityBenefits"
},
{
"properties": {
"benefit": {
"$ref": "#/components/schemas/benefitPostGet"
}
}
}
]
},
"socialSecurity-2": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The start date of the entity. Valide values are either the startDate of the employment or the firstday of a payrolling year.\n\nA (linked chain)[./#section/Data/Date-chains] is maintained within this resource.",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": true
},
"isInsuredForSicknessBenefitsAct": {
"type": "boolean",
"example": true,
"description": "Will contributions for the Sickness Benefits Act (ZW) be payed for this employment",
"readOnly": false,
"x-loket-db-field": "VerzekerdZW",
"x-loket-translation": "https://www.belastingdienst.nl/wps/wcm/connect/bldcontenten/belastingdienst/business/payroll_taxes/you_are_not_established_in_the_netherlands_are_you_required_to_withhold_payroll_taxes/when_you_are_going_to_withhold_payroll_taxes/calculating_payroll_taxes/calculating_employed_persons_insurance_contributions/own-risk_bearer_for_employed_persons_insurance_schemes"
},
"isInsuredForUnemploymentInsuranceAct": {
"type": "boolean",
"example": true,
"description": "Will contributions for the Unemployment Insurance Act (WW) be payed for this employment",
"readOnly": false,
"x-loket-db-field": "VerzekerdWW",
"x-loket-translation": "https://www.belastingdienst.nl/wps/wcm/connect/bldcontenten/belastingdienst/business/payroll_taxes/you_are_not_established_in_the_netherlands_are_you_required_to_withhold_payroll_taxes/when_you_are_going_to_withhold_payroll_taxes/calculating_payroll_taxes/uniform_wage_concept_for_payroll_taxes"
},
"isInsuredForOccupationalDisabilityInsuranceAct": {
"type": "boolean",
"example": true,
"description": "Will contributions for the Occupational Disability Insurance Act (WAO) be payed for this employment",
"readOnly": false,
"x-loket-db-field": "VerzekerdWAO",
"x-loket-translation": "https://www.belastingdienst.nl/wps/wcm/connect/bldcontenten/belastingdienst/business/payroll_taxes/you_are_not_established_in_the_netherlands_are_you_required_to_withhold_payroll_taxes/when_you_are_going_to_withhold_payroll_taxes/calculating_payroll_taxes/calculating_employed_persons_insurance_contributions/calculating_employed_persons_insurance_contributions"
}
}
},
"startPeriod": {
"type": "object",
"format": "metadata",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the first payroll period for which the record is applicable.\n",
"example": 2017,
"minimum": 2000,
"maximum": 9999,
"readOnly": false,
"x-loket-db-field": "eerste 4 cijfers van tabel.PeriodeIngang"
},
"periodNumber": {
"type": "integer",
"format": "int32",
"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.\n",
"example": 1,
"minimum": 1,
"maximum": 53,
"readOnly": false,
"x-loket-db-field": "Laatste 2 cijfers van tabel.PeriodeIngang",
"x-loket-implementation": "Bij het updaten/inserten van dit veld eventueel een leading 0 toevoegen aan het periodenummer als deze kleiner is dan 10. Zodat PeriodeID in de database altijd 6 cijfers bevat met als formatting yyyymm, bijvoorbeeld 201807"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the payroll period.\n",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the payroll period.\n",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
}
}
},
"endPeriod": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the last payroll period for which the record is applicable.\n",
"example": 2017,
"minimum": 2000,
"maximum": 9999,
"readOnly": false,
"x-loket-db-field": "eerste 4 cijfers van tabel.PeriodeEinde"
},
"periodNumber": {
"type": "integer",
"format": "int32",
"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.\n",
"example": 1,
"minimum": 1,
"maximum": 53,
"readOnly": false,
"x-loket-db-field": "Laatste 2 cijfers van tabel.PeriodeEinde",
"x-loket-implementation": "Bij het updaten/inserten van dit veld eventueel een leading 0 toevoegen aan het periodenummer als deze kleiner is dan 10. Zodat PeriodeID in de database altijd 6 cijfers bevat met als formatting yyyymm, bijvoorbeeld 201807"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the payroll period.\n",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the payroll period.\n",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
}
}
},
"deviatingAwfcontributions": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startPeriod": {
"$ref": "#/components/schemas/startPeriod"
},
"endPeriod": {
"$ref": "#/components/schemas/endPeriod"
},
"typeOfDeviatingAwfContribution": {
"type": "object",
"format": "metadata",
"readOnly": false,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The type of deviating Deviating AWF contribution to be applied for this employment.",
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerAfwijkendePremie.SoortAwfPremie"
},
"value": {
"type": "string",
"example": "Hoog",
"description": "Description of the nationality",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Dbo.ctSoortAwfPremie"
}
}
}
}
},
"essAccessWithoutEmployee": {
"type": "object",
"properties": {
"hasTwoFactorAuthentication": {
"type": "boolean",
"example": false,
"description": "Does the employee have two factor authentication enabled",
"readOnly": true
},
"status": {
"type": "string",
"description": "Description of the status",
"maxLength": 50,
"readOnly": true,
"enum": [
"HasAccessToClient",
"NoAccessToClient",
"UserIsBlocked",
"AccessToClientIsBlocked",
"InvitePending",
"InviteFailed",
"InviteCancelled",
"InviteExpired"
]
}
}
},
"employmentCustomField": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"customField": {
"type": "object",
"format": "metadata",
"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).\n",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of the custom field as defined at the employer level",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
"readOnly": false
},
"description": {
"type": "string",
"example": "Shoe size",
"maxLength": 50,
"readOnly": true
}
}
},
"value": {
"type": "string",
"maxLength": 255,
"example": "41",
"description": "The value for the custom field for the employment",
"readOnly": false
}
}
},
"paymentinformationsepa2018-01-01": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"payrollComponent": {
"type": "object",
"format": "metaData",
"readOnly": false,
"description": "The payroll component for which the outgoing payment records applies.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 260,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerExcasso.ComponentID",
"x-loket-implementation1": "Bij het opvoeren/wijzigen van een component moet aan de achterkant ook het veld 'Soort' worden gevuld. De volgende logica; [component 260 = soort 1] , [component 479 = soort 3], [overige componenten = 4]",
"x-loket-implementation2": "Bij het opvoeren/wijzigen van een regel moet aan de achterkant het veld Excasso worden gevuld met numerieke 0 (heeft geen praktische betekenis meer)",
"x-loket-comment": "De waarde van soort is nodig omdat dit nog wordt gebruikt aan de achterkant van Loketje (de gebruiker zegt dit niks. De 'oude' validatie controleert ook op `Soort` maar gezien `Soort=2` niet meer kan voorkomen is het voldoende om te controleren op componentnummer"
},
"value": {
"type": "string",
"example": "NETTOLOON",
"minLength": 0,
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam"
}
}
},
"iban": {
"type": "string",
"example": "NL52ABNA0424968264",
"description": "International Bank Account Number (IBAN). Only IBAN without spaces are accepted.\n",
"minLength": 1,
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerExcasso.IBAN",
"x-loket-implementation": "Bij het opvoeren/ wijzigen van een IBAN moet ook het veld BankGiroRekeningNummer worden gevuld. Bij NL'se IBAN; vertaal naar een correcte giro-rekening. Bij niet NL'se IBAN zet altijd op 1.",
"x-loket-comment": "Het BankGiroRekeningNummer is nodig om dat deze waarde wordt gebruikt voor het berekenen van een controlegetal bij een betaalbestand."
},
"bic": {
"type": [
"string",
"null"
],
"example": "AUDFDE21",
"description": "BIC /SWIFT code. Only applicable for a non-Dutch IBAN\n",
"minLength": 1,
"maxLength": 11,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerExcasso.IBAN"
},
"visibleOnPayslip": {
"type": "boolean",
"example": true,
"description": "Indicates whether the payment-component is visible on a payslip.\n",
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerExcasso.AfdrukkenOpStrook",
"x-loket-implementation": "code 1 = true en code 2 = false (is nu een code tabel wordt boolean)"
},
"nameBeneficiary": {
"type": [
"string",
"null"
],
"example": "Ben Hur",
"description": "Name of beneficiary.\n",
"minLength": 1,
"maxLength": 70,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerExcasso.NaamBegunstigde"
},
"cityBeneficiary": {
"type": [
"string",
"null"
],
"example": "Rome",
"description": "City name of beneficiary.\n",
"minLength": 1,
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerExcasso.PlaatsnaamBegunstigde"
},
"description1": {
"type": [
"string",
"null"
],
"example": "xx",
"description": "Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.\n",
"minLength": 1,
"maxLength": 32,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerExcasso.Omschrijving1",
"x-loket-comment": "Het opknippen van de omschrijving komt uit de tijd van ClieOp. SEPA plakt het gewoon aan elkaar. In de praktijk blijkt het huidige te volstaan (we doen bij deze geen aanpassingen in de functionaliteit/ database)."
},
"description2": {
"type": [
"string",
"null"
],
"example": "x",
"description": "Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.\n",
"minLength": 1,
"maxLength": 32,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerExcasso.Omschrijving2"
}
}
},
"startDate-5": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The start date of the entity.\n\nA (linked chain)[./#section/Data/Date-chains] is maintained within this resource.",
"readOnly": false
},
"endDate-6": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": true
},
"annualSalary": {
"type": "number",
"format": "double",
"pattern": "^(\\d{0,9})$",
"example": 60000,
"description": "The fiscal annual salary. NL: Fiscaal jaarloon",
"minimum": 0,
"maximum": 999999999,
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.Jaarloon"
},
"deviatingTaxTableCode": {
"type": [
"object",
"null"
],
"format": "metadata",
"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",
"x-loket-implementation": "als NULL dan 0 voor database",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.CodeLoonBelastingtabel"
},
"value": {
"type": "string",
"example": "999 Overige gevallen waarin geen tabel is toegepast",
"maxLength": 80,
"readOnly": true,
"x-loket-db-field": "ctCodeLoonbelastingTabel"
}
}
},
"deviatingPayrollTaxTableColour": {
"type": "object",
"format": "metadata",
"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",
"x-loket-comment": "Indicatie of een afwijkende kleur loonheffingentabel moet worden toegepast. De default is in de inrichting van de salarisadministratie opgenomen.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.AfwijkendeKleurLBtabel"
},
"value": {
"type": "string",
"example": "Werknemer belastingpl. en niet premiepl. WLZ",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctKleurLoonbelastingtabel"
}
}
},
"applyDayTables": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Indicates whether the value of the day table is used for the calculation of payroll tax. NL: DagtabelToepassen",
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.DagtabelToepassen"
},
"deviatingPayrollTaxPercentage": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"minimum": 0,
"maximum": 99.99,
"example": 25,
"description": "Indicates the deviating payroll tax percentage which is to be applied. NL: AfwijkendLoonbelastingPercentage",
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.AfwijkendLoonbelastingPercentage"
},
"applyDeviatingPayrollTaxPercentageOn": {
"type": "object",
"format": "metadata",
"description": "Indicates on what type of payroll calculation the deviating payroll tax percentage is applicable. NL: AfwijkendPercentageToepassen",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.AfwijkendPercentageToepassen"
},
"value": {
"type": "string",
"example": "Afwijkend voor tabel- en tariefloon",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLoonbelastingPercentage"
}
}
},
"applyPayrollTaxDeduction": {
"type": "boolean",
"example": true,
"description": "Indicates whether payroll tax deduction is appliclable (loonheffingskorting). NL: ArbeidskortingToepassen",
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.ArbeidskortingToepassen"
},
"applyStudentDeduction": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Apply the \"Scholierenregeling\". NL; ArbeidskortingToepassen",
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.Scholierenregeling",
"x-loket-implementation": "0 DB geeft NULL API"
},
"residentOf": {
"type": "object",
"format": "metadata",
"description": "Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen. NL: InwonerVan\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.InwonerVan"
},
"value": {
"type": "string",
"example": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden",
"description": "Description of the type of document",
"maxLength": 80,
"readOnly": true,
"x-loket-db-field": "dbo.ctInwonerVan.Omschrijving"
}
}
},
"applySalarysplit": {
"type": "object",
"format": "metadata",
"description": "Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen.\n",
"properties": {
"key": {
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.Salarysplit"
},
"value": {
"type": "string",
"example": "LB obv wereldinkomen (%NL/WI)",
"description": "Description of the type of document",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSalarySplit.Omschrijving"
}
}
},
"percentageForeignIncome": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"minimum": 0.01,
"maximum": 99.99,
"example": 50,
"description": "Indicates what percentage of the income of this employment is taxable outside the Netherlands. NL: PercentageBuitenlandsInkomen",
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.PercentageBuitenlandsInkomen"
},
"deviatingCalculationRulePayrollTax": {
"type": "object",
"format": "metadata",
"description": "Indicates if, while calculating payroll taxes and social security contributions, certain deviations are applicable. NL; Herleidingsregel",
"x-loket-comment": "https://www.belastingdienst.nl/wps/wcm/connect/bldcontentnl/themaoverstijgend/brochures_en_publicaties/herleidingsregels_april_2016",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.Uitzondering"
},
"value": {
"type": "string",
"example": "Werknemer belastingpl. en niet premiepl. WLZ",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortLoonbelastingtabel"
}
}
},
"thirtyPercentFacility": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "If the employee comes to work in the Netherlands from another country, the employer may grant an untaxed reimbursement. (30%-regeling).",
"x-loket-comment": "https://www.belastingdienst.nl/wps/wcm/connect/bldcontenten/belastingdienst/individuals/living_and_working/working_in_another_country_temporarily/you_are_coming_to_work_in_the_netherlands/30_facility_for_incoming_employees/",
"x-loket-comment2": "0 = NULL",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.BijzondereKostenVergoeding"
},
"value": {
"type": "string",
"example": "Netto",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBijzondereKostenVergoeding"
}
}
},
"deviatingPercentageThirtyPercentFacility": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,6})?$",
"minimum": 0.000001,
"maximum": 29.999999,
"example": 20.2345,
"description": "Indicates a deviating percentage which should be applied for the 30% facility (30%-regeling)",
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.AfwijkendBijzondereKostenVergoedingPercentage"
},
"doesWageIncludeAow": {
"type": "boolean",
"example": false,
"description": "Indicates whether wage include AOW pension (affects payrolling). NL: LoonInclusiefAowUitkering",
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.LoonInclusiefAowUitkering"
},
"doesWageIncludeWajong": {
"type": "boolean",
"example": false,
"description": "Indicates whether wage include Wajong benefits (affects payrolling). NL: LoonInclusiefWajong",
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.LoonInclusiefWajong"
},
"hasEmployeeLoan": {
"type": "boolean",
"example": false,
"description": "Whether an employee loan (Personeelslening) is applicable may be indicated here. The Personeelslening indirectly affects the income tax calculations.",
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.Personeelslening"
},
"usesTransportByWithholdingAgent": {
"type": "boolean",
"example": false,
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.VervoerVanwegeInhoudingsplichtige"
},
"deviatingSmallJobsArrangement": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Kleine banenregeling",
"readOnly": false
},
"contributionReductionEducation": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Afdr. verm. onderwijs\n",
"properties": {
"key": {
"format": "int32",
"example": 2,
"readOnly": false
},
"value": {
"type": "string",
"example": "4. Opleiding hbo",
"description": "Description of the type of education",
"maxLength": 50,
"readOnly": true
}
}
},
"specialIndication": {
"type": "object",
"readOnly": true,
"description": "Indications This field is no longer used sinds 2005",
"properties": {
"one": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"description": "Speciale aanduiding 1",
"readOnly": true
},
"two": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"description": "Speciale aanduiding 2",
"readOnly": true
},
"three": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"description": "Speciale aanduiding 3",
"readOnly": true
},
"four": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"description": "Speciale aanduiding 4",
"readOnly": true
}
}
},
"applySingleElderlyTaxDeduction": {
"type": "boolean",
"example": false,
"description": "Indicates whether wage include Wajong benefits (affects payrolling). NL: LoonInclusiefWajong",
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.AlleenstaandeOuderenkorting"
},
"fiscal-2": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"$ref": "#/components/schemas/startDate-5"
},
"endDate": {
"$ref": "#/components/schemas/endDate-6"
},
"annualSalary": {
"$ref": "#/components/schemas/annualSalary"
},
"deviatingTaxTableCode": {
"$ref": "#/components/schemas/deviatingTaxTableCode"
},
"deviatingPayrollTaxTableColour": {
"$ref": "#/components/schemas/deviatingPayrollTaxTableColour"
},
"applyDayTables": {
"$ref": "#/components/schemas/applyDayTables"
},
"deviatingPayrollTaxPercentage": {
"$ref": "#/components/schemas/deviatingPayrollTaxPercentage"
},
"applyDeviatingPayrollTaxPercentageOn": {
"$ref": "#/components/schemas/applyDeviatingPayrollTaxPercentageOn"
},
"applyPayrollTaxDeduction": {
"$ref": "#/components/schemas/applyPayrollTaxDeduction"
},
"applyStudentDeduction": {
"$ref": "#/components/schemas/applyStudentDeduction"
},
"residentOf": {
"$ref": "#/components/schemas/residentOf"
},
"applySalarysplit": {
"$ref": "#/components/schemas/applySalarysplit"
},
"percentageForeignIncome": {
"$ref": "#/components/schemas/percentageForeignIncome"
},
"deviatingCalculationRulePayrollTax": {
"$ref": "#/components/schemas/deviatingCalculationRulePayrollTax"
},
"thirtyPercentFacility": {
"$ref": "#/components/schemas/thirtyPercentFacility"
},
"deviatingPercentageThirtyPercentFacility": {
"$ref": "#/components/schemas/deviatingPercentageThirtyPercentFacility"
},
"doesWageIncludeAow": {
"$ref": "#/components/schemas/doesWageIncludeAow"
},
"doesWageIncludeWajong": {
"$ref": "#/components/schemas/doesWageIncludeWajong"
},
"hasEmployeeLoan": {
"$ref": "#/components/schemas/hasEmployeeLoan"
},
"usesTransportByWithholdingAgent": {
"$ref": "#/components/schemas/usesTransportByWithholdingAgent"
},
"deviatingSmallJobsArrangement": {
"$ref": "#/components/schemas/deviatingSmallJobsArrangement"
},
"contributionReductionEducation": {
"$ref": "#/components/schemas/contributionReductionEducation"
},
"specialIndication": {
"$ref": "#/components/schemas/specialIndication"
},
"applySingleElderlyTaxDeduction": {
"$ref": "#/components/schemas/applySingleElderlyTaxDeduction"
}
}
},
"healthcareInsuranceActConfiguration": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The start date of the entity.\n\nA (linked chain)[./#section/Data/Date-chains] is maintained within this resource.",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": true
},
"healthcareInsuranceActType": {
"type": "object",
"format": "metadata",
"description": "Indicates what type of Health Care Insurance Act (Zvw) is applicable for this employment",
"x-loket-translation": "https://www.belastingdienst.nl/wps/wcm/connect/bldcontenten/belastingdienst/business/payroll_taxes/you_are_not_established_in_the_netherlands_are_you_required_to_withhold_payroll_taxes/when_you_are_going_to_withhold_payroll_taxes/calculating_payroll_taxes/calculating_the_income-dependent_contribution_pursuant_to_the_health_care_insurance_act_zvw",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerZvw.SoortZvw"
},
"value": {
"type": "string",
"example": "(C/K) Wel verzekeringsplichtig, normaal tarief",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortZvw"
}
}
},
"additionalContributionEmployer": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,4})(\\.\\d{1,2})?$",
"example": 320,
"description": "If applicable, please enter any additional contribution (extra bijdrage werkgever) for the employer in relation to the Healthcare Insurance Act (Zorgverzekeringswet).",
"minimum": 0.01,
"maximum": 9999.99,
"readOnly": false,
"x-loket-db-field": "ExtraBijdrageWerkgever"
},
"nominalPremium": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,4})(\\.\\d{1,2})?$",
"example": 320,
"description": "A nominal premium (nominale premie) for the Healthcare Insurance Act may be registered here, if applicable.",
"minimum": 0.01,
"maximum": 9999.99,
"readOnly": false,
"x-loket-db-field": "NominalePremie"
},
"additionalPremium": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,4})(\\.\\d{1,2})?$",
"example": 120,
"description": "Additional premium (aanvullende premie) on top of the nomial premium may be registered here, if applicable.",
"minimum": 0.01,
"maximum": 9999.99,
"readOnly": false,
"x-loket-db-field": "AanvullendePremie"
}
}
},
"benefitInKind": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this BenefitInKind starts.\n\nSo 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.\n",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false
},
"benefitInKindType": {
"type": "object",
"format": "metadata",
"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.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "36530F13-59EB-4C15-B5F2-4F92B070A208",
"readOnly": false,
"x-loket-db-field": "loket.werknemerverstrekking.verstrekkingid omzetten naar guid"
},
"description": {
"type": "string",
"example": "Mobiele telefoon",
"readOnly": true,
"x-loket-db-field": "Loket.Verstrekking.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.Verstrekking bevat de Verstrekking voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
},
"brand": {
"type": [
"string",
"null"
],
"example": "Apple",
"description": "The brand of the benefit in kind.",
"maxLength": 30,
"readOnly": false,
"x-loket-db-field": "loket.WerknemerVerstrekking.Merk"
},
"type": {
"type": [
"string",
"null"
],
"example": "Iphone 11",
"description": "The type of the benefit in kind.",
"maxLength": 30,
"readOnly": false,
"x-loket-db-field": "loket.WerknemerVerstrekking.Type"
},
"value": {
"type": "number",
"example": 1100,
"description": "The value for the selected benefit of kind.",
"minimum": 0,
"pattern": "^(\\d{1,5})(\\.\\d{1,2})?$",
"readOnly": false,
"x-loket-db-field": "loket.WerknemerVerstrekking.Waarde"
},
"supplier": {
"type": [
"string",
"null"
],
"example": "Mediamarkt",
"description": "The supplier of the benefit in kind.",
"maxLength": 30,
"readOnly": false,
"x-loket-db-field": "loket.WerknemerVerstrekking.Leverancier"
},
"particularities": {
"type": [
"string",
"null"
],
"example": "geen bijzonderheden",
"description": "Extra information about the benefit in kind",
"maxLength": 4000,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerVerstrekking.Bijzonderheden"
}
}
},
"companyCar": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2021-01-01",
"description": "The start date of the entity.",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2023-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false
},
"brand": {
"type": [
"string",
"null"
],
"example": "Volvo",
"description": "Brand of the vehicle.\n",
"maximum": 25,
"readOnly": false
},
"model": {
"type": [
"string",
"null"
],
"example": "V60",
"description": "Model of the vehicle.\n",
"maximum": 25,
"readOnly": false
},
"licensePlateNumber": {
"type": "string",
"example": "GP586D",
"description": "Vehicle registration number (license plate) of the company car. The number should be provided with or without any hyphens (-).\n",
"minLength": 1,
"maxLength": 8,
"readOnly": false
},
"fuelCardNumber": {
"type": [
"string",
"null"
],
"example": "B100.323.903",
"description": "Registration number of the fuel card.\n",
"maximum": 20,
"readOnly": false
},
"leaseOrBuy": {
"type": "object",
"format": "metaData",
"description": "Indication of the ownership of the company car.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Koop",
"readOnly": true
}
}
},
"supplier": {
"type": [
"string",
"null"
],
"example": "Leasemaatschappij Tilburg",
"description": "Name of the company the delivered the company car.\n",
"maximum": 30,
"readOnly": false
},
"lease": {
"type": [
"object",
"null"
],
"description": "Details of the leasecontract\n",
"properties": {
"startDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2021-01-01",
"description": "The start date of the entity.",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2023-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false
},
"contractNumber": {
"type": [
"string",
"null"
],
"example": "2021.323.903",
"description": "Registration number of the lease contract.\n",
"maximum": 20,
"readOnly": false
}
}
},
"catalogValue": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,6})(.\\d{1,2})?$",
"example": 20000,
"description": "The catalog value of the car.\n",
"maximum": 999999.99,
"readOnly": false
},
"kilometersPrivateUse": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 10000,
"description": "The number kilometers per year the employee can use the car for private purposes.\n",
"readOnly": false
},
"comments": {
"type": [
"string",
"null"
],
"example": "This car is very nice",
"description": "Any comments on the car or the contract.\n",
"maximum": 4000,
"readOnly": false
}
}
},
"fiscalCompanyCar": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2021-01-01",
"description": "The start date of the entity.\n\nA (broken chain)[./#section/Data/Date-chains] is maintained within this resource.",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2023-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false
},
"licensePlateNumber": {
"type": [
"string",
"null"
],
"example": "GP586D",
"description": "Vehicle registration number (license plate) of the fiscal company car. The number should be provided with or without any hyphens (-).\n",
"minLength": 0,
"maxLength": 15,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerAuto.Kenteken"
},
"dateOfFirstAdmission": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-01-01",
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerAuto.DatumEersteToelating"
},
"valueForTaxPurposes": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,6})(.\\d{1,2})?$",
"example": 20000,
"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.\nIt is possible to acquire a value for this field based on the RDW-registration by calling that supplementary endpoint.\n",
"minimum": 0.01,
"maximum": 999999.99,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerAuto.CatalogusWaarde",
"x-loket-implementation": "0 in db == NULL in API"
},
"additionalTaxLiabilityGroup": {
"type": "object",
"format": "metaData",
"description": "Indication for what additional tax liability percentage (bijtelling) should be used for calculating the tax liabiltiy in the payroll process.\n\nIt 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.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerAuto.Bijtelling"
},
"value": {
"type": "string",
"example": "Standaard tarief (25% tot 2017)",
"minLength": 0,
"maxLength": 100,
"readOnly": true,
"x-loket-db-field": "dbo.ctBijtelling"
}
}
},
"reasonForNoAdditionalTaxLiability": {
"type": [
"object",
"null"
],
"format": "metaData",
"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.\n",
"x-loket-implementation": "0 in db == NULL in API",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerAuto.RedenGeenBijtelling"
},
"value": {
"type": "string",
"example": "(2) Werknemer heeft beschikking belastingdienst",
"minLength": 0,
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctRedenGeenBijtellingAuto"
}
}
},
"deviatingAdditionalTaxLiability": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,6})(.\\d{1,2})?$",
"example": 20000,
"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.\n",
"minimum": 0.01,
"maximum": 999999.99,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerAuto.FiscaleBijtelling",
"x-loket-implementation": "0 in db ==> NULL API"
},
"taxableBenefitForPrivateUse": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,6})(.\\d{1,2})?$",
"example": 2000,
"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.\n",
"minimum": 0.01,
"maximum": 999999.99,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerAuto.WerknemerBijdrage",
"x-loket-implementation": "0 in db == NULL in API"
}
}
},
"costCenterAllocationObject": {
"type": "object",
"format": "metadata",
"description": "The applicable cost center (=kostenplaats).\n\n`costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.VerdelingJournaalDetail.KostenplaatsID",
"x-loket-implementation": "Kan geen GUID zijn vanwege de overerving. De code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "SAL073",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Sales Den Bosch",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"costUnitAllocationObject": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The applicable cost center (=kostendrager).\n`costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-implementation": "null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.VerdelingJournaalDetail.KostendragerID",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. en code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "01",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Cars",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"journalAllocationObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id",
"x-loket-implementation": "betreffende tabellen zijn Loket.VerdelingJournaal en Loket.VerdelingJournaalDetail"
},
"journalProfileConfiguration": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "Indicates to which journal profiel configuration the record relates",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"startPeriod": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the first payroll period for which the journal allocation is applicable.\n",
"example": 2017,
"minimum": 2000,
"maximum": 9999,
"readOnly": true
},
"periodNumber": {
"type": "integer",
"format": "int32",
"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.\n",
"example": 1,
"minimum": 1,
"maximum": 53,
"readOnly": true
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the payroll period.\n",
"example": "2017-01-01",
"readOnly": true
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the payroll period.\n",
"example": "2017-01-31",
"readOnly": true
}
}
},
"endPeriod": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the first payroll period for which the journal allocation is applicable.\n",
"example": 2017,
"minimum": 2000,
"maximum": 9999,
"readOnly": true
},
"periodNumber": {
"type": "integer",
"format": "int32",
"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.\n",
"example": 1,
"minimum": 1,
"maximum": 53,
"readOnly": true
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the payroll period.\n",
"example": "2017-01-01",
"readOnly": true
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the payroll period.\n",
"example": "2017-01-31",
"readOnly": true
}
}
},
"journalProfile": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false
},
"value": {
"type": "string",
"example": "General ledger supermarkets",
"readOnly": true
}
}
}
}
},
"startPeriod": {
"type": "object",
"format": "metadata",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the first payroll period for which the journal allocation is applicable.\n",
"example": 2017,
"minimum": 2000,
"maximum": 9999,
"readOnly": false,
"x-loket-db-field": "eerste 4 cijfers van Loket.VerdelingJournaal.PeriodeIngang"
},
"periodNumber": {
"type": "integer",
"format": "int32",
"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.\n",
"example": 1,
"minimum": 1,
"maximum": 53,
"readOnly": false,
"x-loket-db-field": "Laatste 2 cijfers van Loket.VerdelingJournaal.PeriodeIngang",
"x-loket-implementation": "Bij het updaten/inserten van dit veld eventueel een leading 0 toevoegen aan het periodenummer als deze kleiner is dan 10. Zodat PeriodeID in de database altijd 6 cijfers bevat met als formatting yyyymm, bijvoorbeeld 201807"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the payroll period.\n",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the payroll period.\n",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
}
}
},
"endPeriod": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the last payroll period for which the journal allocation is applicable.\n",
"example": 2017,
"minimum": 2000,
"maximum": 9999,
"readOnly": false,
"x-loket-db-field": "eerste 4 cijfers van Loket.VerdelingJournaal.PeriodeEinde"
},
"periodNumber": {
"type": "integer",
"format": "int32",
"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.\n",
"example": 1,
"minimum": 1,
"maximum": 53,
"readOnly": false,
"x-loket-db-field": "Laatste 2 cijfers van Loket.VerdelingJournaal.PeriodeEinde",
"x-loket-implementation": "Bij het updaten/inserten van dit veld eventueel een leading 0 toevoegen aan het periodenummer als deze kleiner is dan 10. Zodat PeriodeID in de database altijd 6 cijfers bevat met als formatting yyyymm, bijvoorbeeld 201807"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the payroll period.\n",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the payroll period.\n",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
}
}
},
"allocationBasedOnActualHours": {
"x-loket-implementation": "als dit object gevuld is zet dan SoortVerdeling op 1",
"type": [
"object",
"null"
],
"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 (!).\n\nPlease note that this object MUST be null when `allocationBasedOnFixedWeights` is to be applied. Only one of the two may be provided.\n",
"properties": {
"costCenter": {
"$ref": "#/components/schemas/costCenterAllocationObject"
},
"costUnit": {
"$ref": "#/components/schemas/costUnitAllocationObject"
}
}
},
"allocationBasedOnFixedWeights": {
"x-loket-implementation": "als dit object gevuld is zet dan SoortVerdeling op 2",
"type": [
"array",
"null"
],
"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.\n\nPlease note that this object MUST be null when `allocationBasedOnActualHours` is to be applied. Only one of the two may be provided. \n",
"items": {
"type": "object",
"properties": {
"costCenter": {
"$ref": "#/components/schemas/costCenterAllocationObject"
},
"costUnit": {
"$ref": "#/components/schemas/costUnitAllocationObject"
},
"weight": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The weight (factor) determines the relative weight when allocating the costs for this specific combination of costCenter and costUnit.\n",
"minimum": 1,
"maximum": 9999,
"readOnly": false,
"x-loket-db-field": "Loket.VerdelingJournaalDetail.Factor"
}
}
}
}
}
},
"basesForCalculationGetPost": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this base starts.\n\nA (linked chain)[./#section/Data/Date-chains] per base is maintained within this resource.\nSo multiple bases can be active at the same time but one specific base can never be active multiple times at the same time.",
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking.DatumIngang"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking.DatumEinde"
},
"deviations": {
"type": [
"object",
"null"
],
"readOnly": false,
"description": "Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `base`. \nSet `deviations` to null if no deviations apply.\n\nDeviating is done on either all the fields or none.",
"x-loket-implementation": "Vulling/aanwezigheid van dit element is afhankelijk van \"[BerekeningSoort]\"(ctPensioenPremieBerekeningSoort). Indien [BerekeningSoort] = 1 dan element op null stellen. Indien [BerekeningSoort] = 2 het element opnemen en sub-elementen vullen (zie subelementen elementen hoe te vullen).",
"properties": {
"percentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,6})?$",
"example": 8,
"description": "Deviation from the percentage",
"minimum": 0,
"maximum": 999.999999,
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking.Percentage"
},
"reservationPercentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,6})?$",
"example": 12.0007,
"description": "deviation from the reservation percentage",
"minimum": 0,
"maximum": 999.999999,
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking.ReserveringsPercentage"
},
"financialReservationPercentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,6})?$",
"example": 10.000007,
"description": "deviation from the financial reservation percentage",
"minimum": 0,
"maximum": 999.999999,
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking.ReserveringsPercentageFinancieel"
}
}
},
"ageBasedMinimum": {
"type": "object",
"format": "metadata",
"description": "This fields indicates how the age based minimum is applied\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The number for the ageBasedMinimum\n",
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking"
},
"value": {
"type": "string",
"example": "Toepassen hoogste leeftijd",
"description": "The description of the ageBasedMinimum\n",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.ctGrondslagMinimumMaximum"
}
}
},
"ageBasedMaximum": {
"type": "object",
"format": "metadata",
"description": "This fields indicates how the age based maximum is applied\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The number for the ageBasedMaximum\n",
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking"
},
"value": {
"type": "string",
"example": "Toepassen hoogste leeftijd",
"description": "The description of the ageBasedMaximum\n",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.ctGrondslagMinimumMaximum"
}
}
},
"base": {
"type": "object",
"format": "metadata",
"description": "`base` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-implementation": "Dit veld is in de interface read only bij het wijzigen.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 545,
"description": "The number for the base\n",
"readOnly": false,
"x-loket-db-field": "Loket..grondslagId"
},
"value": {
"type": "string",
"example": "VAKANTIE TOESLAG, periodieke opbouw",
"description": "The description of the base\n",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Ulsa.grondslag.omschrijving",
"x-loket-implementation": "Omdat hier met datums en niet met verloningsperiodes gewerkt wordt moet de beschrijving van het actieve jaar gebruikt worden."
}
}
}
}
},
"otherPayrollVariables-2": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this record starts.\n\nA (broken chain)[./#section/Data/Date-chains] is maintained with this record.",
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerDiversenSalarisverwerking.DatumIngang"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerDiversenSalarisverwerking.DatumEinde"
},
"productivityPercentage": {
"type": "number",
"format": "double",
"example": 100,
"minimum": 0,
"maximum": 100,
"pattern": "^(\\d{1,3})(\\.\\d{1,2})?$",
"description": "productivityPercentage (Productiviteitspercentage) can be used to indicate the productivity percentage of an employment.",
"readOnly": false,
"x-loket-db-field": "productiviteitspercentage"
},
"payrollProperties": {
"type": "object",
"properties": {
"deviatingPremiumGroup": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.",
"x-loket-implementation": "0 = null",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.WerknemerDiversenSalarisverwerking.Premiegroep"
},
"value": {
"type": "string",
"example": "(1) Agrarisch bedrijf kort",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctPremiegroep"
}
}
},
"wageCostBenefit": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Wage cost benefit (loonkostenvoordeel (LKV)). If applicable select the correct option to reduces the costs for an employer to employ the employee. \n\n__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.",
"x-loket-implementation": "0 = null",
"x-loket-implementation1": "Er is hier expres afgeweken van de logica in loket 2 wat betreft de einddatum. Het verschil tussen de API en GUI2 vinden we echter nog groot genoeg om dit in L2 ook nog aan te passen (groot als in veel gebruikers gaan hier tegen aan lopen)",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.WerknemerDiversenSalarisverwerking.loonkostenvoordeel"
},
"value": {
"type": "string",
"example": "LKV herplaatsen arbeidsgehandicapte werknemer",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLoonkostenvoordeel"
}
}
},
"wajongWithWageDispensation": {
"type": "boolean",
"example": false,
"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.",
"readOnly": false,
"x-loket-db-field": "loket.WerknemerDiversenSalarisverwerking.wajongmetloondispensatie",
"x-loket-implementation": "ctJaNee naar een boolean"
},
"phaseClassification": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Phase classification (Fase indeling) \n\nIndicatie die aangeeft in welke fase de inkomstenverhouding voor bepaalde tijd zich bevindt in het kader van de Wet Flexibiliteit en Zekerheid.",
"x-loket-implementation": "0 = null",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.WerknemerDiversenSalarisverwerking.faseindeling"
},
"value": {
"type": "string",
"example": "(38) Fase A zonder uitzendbeding met uitsluiting van ldv",
"maxLength": 60,
"readOnly": true,
"x-loket-db-field": "dbo.ctFaseIndeling"
}
}
},
"incidentalIncomeDeduction": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Incidental income deduction (Incidentele inkomstenvermindering) \n\nIndien 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 niet automatisch bepalen of er sprake is van een incidentele inkomstenvermindering. In deze rubriek dient dan de juiste waarde ingevuld te worden",
"x-loket-implementation": "0 = null",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.WerknemerDiversenSalarisverwerking.incidenteleinkomstenvermindering"
},
"value": {
"type": "string",
"example": "Bevalling of zwangerschap",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctIncidenteleInkomstenvermindering"
}
}
},
"terminateIncomenumberFlexibleEmployment": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Terminate incomenumber flexible employment (Einde inkomstenverh.Flexwerker) ",
"x-loket-implementation": "0 = null",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.WerknemerDiversenSalarisverwerking.redeneindeinkomstenverhoudingflexwerker"
},
"value": {
"type": "string",
"example": "(1) Einde werk/contract, geen werk aangeboden",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctRedenEindeInkomstenverhoudingFlexwerker"
}
}
},
"applyMinimumWageVocationalLearningPathway": {
"type": "boolean",
"description": "Minimum wage vocational learning pathway (Minimumloon BBL) ",
"readOnly": false,
"x-loket-db-field": "loket.WerknemerDiversenSalarisverwerking.indicatiebbl",
"x-loket-implementation": "ctJaNee naar een boolean"
},
"occupationalDisabilityPremiumDiscount": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Occupational disability premium discount (arbeidsgehandicaptenkorting) not to be used after 2017. It indicates if \"arbeidsgehandicaptenkorting\" is applicable to this employment.\n\nIndicatie die aangeeft of er arbeidsgehandicaptenkorting of korting in dienst nemen van ouderen werknemer van toepassing is. Loket 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 als code 5.",
"x-loket-implementation": "0 = null",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.WerknemerDiversenSalarisverwerking.arbeidsgehandicaptenkorting"
},
"value": {
"type": "string",
"example": "(7) Werknemer van 62, 63 of 64 jaar voor wie code 6 niet van toepassing is",
"maxLength": 80,
"readOnly": true,
"x-loket-db-field": "dbo.ctArbeidsgehandicaptenKorting"
}
}
},
"occupationalDisabilityDeductionAfter2009": {
"type": [
"number",
"null"
],
"format": "double",
"example": 1,
"description": "(OccupationalDisability) Deduction after 2009 (Arbeidsgeh.krt na 2009 (tm 2009 WAO)) \nTot 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 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",
"minimum": 0.01,
"maximum": 9999.99,
"readOnly": false,
"x-loket-db-field": "arbeidsgehandicaptenkortingwao",
"x-loket-implementation": "0 = null"
},
"occupationalDisabilityDeductionTo2009": {
"type": [
"number",
"null"
],
"format": "double",
"example": 1,
"description": "(OccupationalDisability) Deduction to 2009 (including 2009) (Arbeidsgeh.krt (tm 2009 AWF/UFO))\nTot 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 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",
"minimum": 0.01,
"maximum": 9999.99,
"readOnly": false,
"x-loket-db-field": "arbeidsgehandicaptenkortingawfufo",
"x-loket-implementation": "0 = null"
},
"collectiveLaborAgreementCodeHiringEmployer": {
"type": [
"object",
"null"
],
"format": "metadata",
"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\".\nFor more information when to set this value please check \"Gegevensspecificaties aangifte loonheffingen 2020 v2.0 11 juli 2019\"",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 151,
"readOnly": false
},
"value": {
"type": "string",
"example": "TUINBOUWVEILINGEN",
"maxLength": 90,
"readOnly": true
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The start date of the CAO",
"readOnly": true
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the CAO",
"readOnly": true
}
}
},
"applyYearlyHoursNorm": {
"type": "boolean",
"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,
"readOnly": false
}
}
},
"pensionProperties": {
"type": "object",
"properties": {
"annualCalculationBaseAbp": {
"type": [
"number",
"null"
],
"format": "double",
"example": 1.5,
"description": "annualCalculationBase (jaargrondslag voor ABP) for ABP. As of 1-1-2026, this field will no longer be used and must be filled with 0.",
"minimum": 0.01,
"maximum": 999999.99,
"pattern": "^(\\d{1,6})(\\.\\d{1,2})?$",
"readOnly": false,
"x-loket-db-field": "loket.WerknemerDiversenSalarisverwerking.JaargrondslagABPofPGGM",
"x-loket-implementation": "0 = null"
},
"leaveAbp": {
"type": [
"object",
"null"
],
"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",
"x-loket-implementation": "als leaveType en valueOfParticipationDuringLeave de waarde 0 hebben leaveAbp op null stellen",
"properties": {
"leaveType": {
"type": "object",
"format": "metadata",
"description": "Leave type (Verlofsoort ABP) for ABP. ",
"x-loket-implementation": "indien leaveAbp = null dan voor leaveType 0 in de DB vullen",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.WerknemerDiversenSalarisverwerking.AbpVerlofSoort"
},
"value": {
"type": "string",
"example": "Politiek verlof",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctAbpVerlof"
}
}
},
"valueOfParticipationDuringLeave": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "valueOfParticipation (waardeDeelnemerschap) (pensioen opbouw voor ambtenaren ABP)",
"minimum": 1,
"maximum": 100,
"readOnly": false,
"x-loket-implementation": "indien leaveAbp = null dan voor valueOfParticipationDuringLeave 0 in de DB vullen",
"x-loket-db-field": "AbpVerlofPercentage"
}
}
},
"deviatingDisabilityInsuranceActPercentageForCordares": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "deviatingDisabilityInsuranceActPercentageForCordares (WAO % Cordares) used for Cordares. ",
"x-loket-implementation": "0 = null",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.WerknemerDiversenSalarisverwerking.waopercentagecordares"
},
"value": {
"type": "string",
"example": "15- 25 %",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctWaoPercentageCordares"
}
}
},
"applyDispensationRiskFund": {
"type": "boolean",
"example": false,
"description": "applyDispensationRiskFund (Disp. risicofonds) ",
"readOnly": false,
"x-loket-db-field": "dispensatierisicofonds",
"x-loket-implementation": "ctJaNee naar een boolean"
},
"compulsoryEducationDays": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 2,
"description": "compulsoryEducationDays (Aantal dagen leerplicht) ",
"minimum": 1,
"maximum": 2,
"readOnly": false,
"x-loket-db-field": "aantaldagenleerplicht",
"x-loket-implementation": "0 = null"
},
"occupationalPensionFund": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 2,
"description": "Occupational Pension Fund (BPF-code) ",
"minimum": 1,
"maximum": 99,
"readOnly": false,
"x-loket-implementation": "0 = null",
"x-loket-db-field": "bedrijfspensioenfonds"
},
"specificationOfIncomeRelationshipApg": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "specificationOfIncomeRelationship (APGVerbijzonderingInkomstenverhouding) used for the APG pension fund. ",
"x-loket-implementation": "0 = null",
"x-loket-implementation1": "De mogelijke waardes zijn afhankelijk van klantgroep instelling op ADM niveau",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "loket.WerknemerDiversenSalarisverwerking.apgverbijzonderinginkomstenverhouding"
},
"value": {
"type": "string",
"example": "Geen bijzonderheden",
"maxLength": 75,
"readOnly": true,
"x-loket-db-field": "dbo.ctApgVerbijzonderingInkomstenverhouding.Omschrijving"
},
"code": {
"type": "string",
"example": "WNE",
"maxLength": 4,
"readOnly": true,
"x-loket-db-field": "dbo.ctApgVerbijzonderingInkomstenverhouding.CodeAangifte"
}
}
}
}
},
"insuranceProperties": {
"type": "object",
"properties": {
"applicableForNoRiskPolicy": {
"type": "boolean",
"description": "Indicates if the employment is applicable for the \"Looncompensatie bij ziekte (no-riskpolis)\" as defined by the UWV.\n\nPlease check with the UWV to determine when to set the value to true.",
"example": false,
"readOnly": false,
"x-loket-db-field": "noRiskpolis",
"x-loket-implementation": "ctJaNee naar een boolean"
}
}
}
}
},
"paymentInformationNonSepa": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"payrollComponent": {
"type": "object",
"format": "metaData",
"readOnly": false,
"description": "The payroll component for which the outgoing payment records applies.\nEach payroll component can only be used once per employment.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 260,
"description": "The number for the payroll component\n",
"readOnly": false,
"x-loket-db-field": "ComponentID",
"x-loket-implementation1": "Bij het opvoeren/wijzigen van een component moet aan de achterkant ook het veld 'Soort' worden gevuld. De volgende logica; [component 260 = soort 1] , [component 479 = soort 3], [overige componenten = 4]",
"x-loket-implementation2": "Bij het opvoeren/wijzigen van een regel moet aan de achterkant het veld Excasso worden gevuld met numerieke 0 (heeft geen praktische betekenis meer)",
"x-loket-comment": "De waarde van soort is nodig omdat dit nog wordt gebruikt aan de achterkant van Loketje (de gebruiker zegt dit niks. De 'oude' validatie controleert ook op `Soort` maar gezien `Soort=2` niet meer kan voorkomen is het voldoende om te controleren op componentnummer"
},
"value": {
"type": "string",
"example": "NETTOLOON",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)",
"x-loket-implementation": "Omdat hier zonder datums of verloningsperiodes gewerkt wordt moet de beschrijving van het actieve jaar gebruikt worden."
}
}
},
"bankAccountNumber": {
"type": "string",
"example": "0403830171874018",
"description": "The bank account number\n",
"minLength": 1,
"maxLength": 34,
"readOnly": false,
"x-loket-db-field": "BankGiroRekeningnummer"
},
"beneficiary": {
"type": "object",
"description": "Information regarding the beneficiary coresponding with the bank account number",
"properties": {
"name": {
"type": "string",
"example": "Ben Hur",
"description": "Name of the beneficiary\n",
"minLength": 1,
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "Loket.NaamBegunstigde"
},
"city": {
"type": "string",
"example": "Rome",
"description": "City name of beneficiary\n",
"minLength": 1,
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "Loket.PlaatsnaamBegunstigde"
},
"address": {
"type": "string",
"example": "Via Roma 3",
"description": "Address of beneficiary\n",
"minLength": 1,
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "Loket.AdresBegunstigde"
},
"country": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the country.\n\nPossible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "LandBegunstigde"
},
"value": {
"type": "string",
"example": "Netherlands",
"description": "The name of the country",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.Omschrijving"
},
"isoCode": {
"type": "string",
"example": "NL",
"description": "The ISO 3166-1 alpha-2 value for the country",
"maxLength": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.IsoCode"
}
}
}
}
},
"bank": {
"type": "object",
"description": "Information regarding the bank coresponding with the bank account number",
"properties": {
"bankIdentifierCode": {
"type": "string",
"example": "AUDFDE21",
"description": "BIC /SWIFT code for the bank\n",
"minLength": 1,
"maxLength": 11,
"readOnly": false,
"x-loket-db-field": "BICBankBegunstigde"
},
"name": {
"type": "string",
"example": "Ben Hur",
"description": "Name of benificiary bank\n",
"minLength": 1,
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "Loket.NaamBankBegunstigde"
},
"city": {
"type": "string",
"example": "Rome",
"description": "City name of beneficiary bank\n",
"minLength": 1,
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "Loket.PlaatsnaamBankBegunstigde"
},
"address": {
"type": "string",
"example": "Via Roma 3",
"description": "Address of beneficiary bank\n",
"minLength": 1,
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "Loket.adresBankBegunstigde"
},
"country": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the country.\nPossible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "LandBankBegunstigde"
},
"value": {
"type": "string",
"example": "Netherlands",
"description": "The name of the country",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.Omschrijving"
},
"isoCode": {
"type": "string",
"example": "NL",
"description": "The ISO 3166-1 alpha-2 value for the country",
"maxLength": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.IsoCode"
}
}
}
}
}
}
},
"basesForEmploymentFundCalculationBaseObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this base for calculation starts.\n\nA (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",
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfondsgrondslag.DatumIngang"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfondsgrondslag.DatumEinde"
},
"origin": {
"type": "object",
"format": "metadata",
"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.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the origin\n",
"readOnly": true,
"x-loket-db-field": "Loket.werknemerfondsgrondslag.MutatieHerkomst"
},
"value": {
"type": "string",
"example": "Normale wijziging",
"description": "The description of the origin\n",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctMutatieHerkomst.omschrijving"
}
}
},
"base": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,6})(\\.\\d{1,2})?$",
"description": "The base (amount of money) to be used in the fund calculation\n",
"example": 25000,
"minimum": 0.01,
"maximum": 999999.99,
"readOnly": false
}
}
},
"pensionBenefits": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this pension benefit starts\n\nA (broken chain)[./#section/Data/Date-chains] is maintained within this resource.",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": true
},
"payout": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 2569,
"description": "The ammount of (gross) pension received",
"minimum": 0,
"maximum": 100000,
"readOnly": false
}
}
},
"startDate-6": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this DeviatingHouryWage starts.\n\nA (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.",
"readOnly": false
},
"endDate-7": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false
},
"payrollComponent-2": {
"type": "object",
"format": "metadata",
"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.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-implementation": "Dit veld is in de interface read only bij het wijzigen.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 70,
"description": "The number for the payroll component.\n",
"readOnly": false
},
"description": {
"type": "string",
"example": "LOON/SALARIS",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true
}
}
},
"value": {
"type": "number",
"example": 50.87,
"description": "The value for the selected payroll component.\n",
"minimum": 0.01,
"maximum": 99999.99,
"pattern": "^(\\d{1,5})(\\.\\d{1,2})?$",
"readOnly": false
},
"deviatingHourlyWages": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"$ref": "#/components/schemas/startDate-6"
},
"endDate": {
"$ref": "#/components/schemas/endDate-7"
},
"payrollComponent": {
"$ref": "#/components/schemas/payrollComponent-2"
},
"value": {
"$ref": "#/components/schemas/value"
}
}
},
"employmentComprehensiveResponse2019-12-16": {
"allOf": [
{
"type": "object",
"properties": {
"employee": {
"$ref": "#/components/schemas/employee2021-03-29"
}
}
},
{
"type": "object",
"properties": {
"employment": {
"$ref": "#/components/schemas/employment2019-12-16"
}
}
},
{
"type": "object",
"properties": {
"workinghours": {
"$ref": "#/components/schemas/workinghours"
}
}
},
{
"type": "object",
"properties": {
"organizationalEntity": {
"$ref": "#/components/schemas/organizationalEntity-2"
}
}
},
{
"type": "object",
"properties": {
"wage": {
"$ref": "#/components/schemas/wage-2"
}
}
},
{
"type": "object",
"properties": {
"socialSecurityBenefits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/socialSecurityBenefitsPostGet"
}
}
}
},
{
"type": "object",
"properties": {
"socialSecurityConfiguration": {
"$ref": "#/components/schemas/socialSecurity-2"
}
}
},
{
"type": "object",
"properties": {
"deviatingAwfContribution": {
"$ref": "#/components/schemas/deviatingAwfcontributions"
}
}
},
{
"type": "object",
"properties": {
"citizenServiceNumber": {
"$ref": "#/components/schemas/citizenServiceNumber-2"
}
}
},
{
"type": "object",
"properties": {
"statusEmployeeSelfService": {
"$ref": "#/components/schemas/essAccessWithoutEmployee"
}
}
},
{
"type": "object",
"properties": {
"employmentCustomFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employmentCustomField"
}
}
}
},
{
"type": "object",
"properties": {
"employeeCustomFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/employeeCustomField"
}
}
}
},
{
"type": "object",
"properties": {
"paymentInformationSepa": {
"type": "array",
"items": {
"$ref": "#/components/schemas/paymentinformationsepa2018-01-01"
}
}
}
},
{
"type": "object",
"properties": {
"fiscalProperties": {
"$ref": "#/components/schemas/fiscal-2"
}
}
},
{
"type": "object",
"properties": {
"healthcareInsuranceActConfiguration": {
"$ref": "#/components/schemas/healthcareInsuranceActConfiguration"
}
}
},
{
"type": "object",
"properties": {
"benefitsInKind": {
"type": "array",
"items": {
"$ref": "#/components/schemas/benefitInKind"
}
}
}
},
{
"type": "object",
"properties": {
"companyCars": {
"type": "array",
"items": {
"$ref": "#/components/schemas/companyCar"
}
}
}
},
{
"type": "object",
"properties": {
"fiscalCompanyCars": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fiscalCompanyCar"
}
}
}
},
{
"type": "object",
"properties": {
"journalAllocation": {
"$ref": "#/components/schemas/journalAllocationObject"
}
}
},
{
"type": "object",
"properties": {
"basesForCalculation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/basesForCalculationGetPost"
}
}
}
},
{
"type": "object",
"properties": {
"otherPayrollVariables": {
"$ref": "#/components/schemas/otherPayrollVariables-2"
}
}
},
{
"type": "object",
"properties": {
"paymentinformationNonSepa": {
"type": "array",
"items": {
"$ref": "#/components/schemas/paymentInformationNonSepa"
}
}
}
},
{
"type": "object",
"properties": {
"basesForEmploymentFundCalculation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/basesForEmploymentFundCalculationBaseObject"
}
}
}
},
{
"type": "object",
"properties": {
"pensionBenefits": {
"$ref": "#/components/schemas/pensionBenefits"
}
}
},
{
"type": "object",
"properties": {
"deviatingHourlyWages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/deviatingHourlyWages"
}
}
}
}
]
},
"employee-2": {
"type": "object",
"properties": {
"iban": {
"type": [
"string",
"null"
],
"example": "NL52ABNA0424968264",
"description": "International Bank Account Number. Only IBAN without spaces are accepted.",
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "Loket.Conceptwerknemer.IBAN"
}
}
},
"employment-2": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"format": "date",
"example": "2019-01-01",
"description": "The date on which this employment starts.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.DatumInDienst"
},
"historicalStartDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2012-05-01",
"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.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.HistorischeDatumInDienst"
},
"payrollAdministration": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "An administration used for payrolling. This field can not have a value at the same time as `nonPayrollAdministration`\n\n`payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user. ",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-implementation": "Komt uit ulsa.werkgever ipv loket.verloning"
},
"name": {
"type": "string",
"example": "ABC accountants",
"description": "Name of the payroll administration",
"maxLength": 70,
"readOnly": true,
"x-loket-db-field": "Ulsa.Werkgever.Naam --> Dit is anders als wat we nu doen nu komt de naam uit loket.verloning.Omschrijving"
},
"clientNumber": {
"type": "integer",
"format": "int32",
"example": 1234,
"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.",
"readOnly": true,
"x-loket-db-field": "Ulsa.Werkgever.ClientNummer & Loket.Verloning.ClientNr",
"x-loket-implementation": "Het clientnummer is de verbinding tussen Ulsa.Werkgever en Loket.Verloning. Een waarde 0 in de database wordt als NULL teruggegeven in de API."
},
"description": {
"type": "string",
"example": "Bakker",
"description": "Description of the administration",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.Verloning.Omschrijving"
}
}
},
"nonPayrollAdministration": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "An administration that can not be used for payrolling. This field can not have a value at the same time as `payrollAdministration`\n\n`nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-implementation": "Komt uit loket.verloning ipv ulsa.werkgever"
},
"name": {
"type": [
"string",
"null"
],
"example": "ABC accountants",
"description": "Name of the administration",
"maxLength": 70,
"readOnly": true,
"x-loket-db-field": "loket.Verloning.Omschrijving"
},
"description": {
"type": "string",
"example": "Bakker",
"description": "Description of the administration",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.Verloning.Omschrijving"
}
}
},
"commissionUntilDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2019-01-01",
"description": "The date on which the employment will end.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.AanstellingTot"
},
"incomeRelationshipNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"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.",
"minimum": 0,
"maximum": 9999,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.NummerInkomstenVerhouding"
},
"employeeProfileId": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "References to an employeeprofile that is specified in the payroll administration level\n\n`employeeProfileId` is a metadata field within the payroll administration context. Possible values can be managed by the user. ",
"x-loket-implementation": "Let op: moet gefilterd op actieve jaar. Maw alleen profielen voor het actieve moeten worden overgenomen. als NULL dan 0 voor database",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Conceptwerknemer.WerknemerProfielID"
},
"value": {
"type": "string",
"example": "Profiel full-timers",
"readOnly": true,
"x-loket-db-field": "Ulsa.Werknemerprofiel.Omschrijving"
}
}
},
"employmentDurationType": {
"type": "object",
"format": "metadata",
"description": "A selection of pre defined durations for the employment.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.SoortDienstverband"
},
"value": {
"type": "string",
"example": "Contract of indefinite duration",
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortDienstverband.Omschrijving"
}
}
},
"startDateContractOfIndefiniteDuration": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-05-08",
"description": "When did the value of `employmentDurationType` change for definite to indefinite. This value should be te same as the `startDate` if the contract was indefinite from the start.",
"readOnly": false
},
"employmentContractType": {
"type": "object",
"format": "metadata",
"description": "The type of employment applicable for the employment.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.BasisDienstverband"
},
"value": {
"type": "string",
"example": "Labor agreement",
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisDienstverband.Omschrijving"
}
}
},
"typeOfEmployee": {
"type": "object",
"format": "metadata",
"description": "A selection of pre defined employee-types for the employment.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Conceptwerknemer.SoortWerknemer"
},
"value": {
"type": "string",
"example": "Werknemer",
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortWerknemer.Omschrijving"
}
}
},
"cancellationPeriodEmployee": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"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.",
"minimum": 1,
"maximum": 1000,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.OpzegtermijnWerknemer",
"x-loket-implementation": "0 = null"
},
"cancellationPeriodEmployer": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"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.",
"minimum": 1,
"maximum": 1000,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.OpzegtermijnWerkgever",
"x-loket-implementation": "0 = null"
},
"cancellationPeriodTimeUnit": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The unit of time used for the noticePeriodeEmployee and noticePeriodEmployer properties.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 4,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.PeriodeOpzegTermijn"
},
"value": {
"type": "string",
"example": "Maand(en)",
"readOnly": true,
"x-loket-db-field": "dbo.ctPeriode.Omschrijving"
}
}
},
"cancellationNoticeDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2019-05-31",
"description": "The date on which the notice was given by either the employee or the employer.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.DatumOpzegging"
},
"startCancellationNoticePeriod": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2019-06-01",
"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.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.AanvangOpzegtermijn"
},
"isDirectorAndMajorShareholder": {
"type": [
"boolean",
"null"
],
"example": false,
"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.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.IsDirecteurGrootAandeelhouder",
"x-loket-implementation": "In de database is dit een non-nullable veld. In de API vertalen we dit alsvolgt: 0 = null, 1 = true, 2 = false"
},
"isOnCallEmployment": {
"type": "boolean",
"example": true,
"description": "Indicates whether the employment is an on-call employment.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.IsOproepkrachtOfInvalkracht"
},
"hasOnCallAppearanceObligation": {
"type": [
"boolean",
"null"
],
"example": true,
"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.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.SoortOproepkrachtOfInvalkracht",
"x-loket-implementation": "In de database correspondeert dit veld met de codetabel ctSoortOproepkrachtOfInvalkracht. In de API maken we dit een nullable boolean met de volgende mapping: 0 = null, 1 = false, 2 = true. LET OP: deze mapping wijkt af van de mappings hierboven die gebaseerd zijn op de codetabel ctOnbekendJaNee."
},
"vacationCoupons": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indication for vacation coupons (vakantiebonnen). This is only applies to a limited set of CLA`s.",
"x-loket-implementation": "Indien de waarde 0 (n.v.t.) is het element NULL maken",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Vakantiebonnen"
},
"value": {
"type": "string",
"example": "n.v.t.",
"readOnly": true,
"x-loket-db-field": "dbo.ctVakantiebonnen"
}
}
},
"specialIncomeRatio": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates the special income ratio",
"x-loket-implementation": "als NULL dan 0 voor database",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": false,
"x-loket-db-field": "Loket.SoortConceptWerknemer.SpecialeInkomstenVerhouding"
},
"value": {
"type": "string",
"example": "n.v.t.",
"readOnly": true,
"x-loket-db-field": "dbo.ctSpecialeInkomstenVerhouding.Omschrijving"
}
}
},
"isAnonymousEmployee": {
"type": "boolean",
"example": true,
"description": "Indicates whether employee is anonymous ",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.IsAnoniemeWerknemer",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"isPreviousOwner": {
"type": [
"boolean",
"null"
],
"example": false,
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.SoortConceptWerknemer.IsVorigeEigenaar",
"x-loket-implementation": "In de database is dit een non-nullable veld. In de API vertalen we dit alsvolgt: 0 = null, 1 = true, 2 = false"
},
"isFamilyOfOwner": {
"type": [
"boolean",
"null"
],
"example": false,
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.SoortConceptWerknemer.IsFamilieVaneEigenaar",
"x-loket-implementation": "In de database is dit een non-nullable veld. In de API vertalen we dit alsvolgt: 0 = null, 1 = true, 2 = false"
},
"isGemoedsbezwaardNationalInsurance": {
"type": "boolean",
"example": true,
"description": "Gemoedsbezwaard Volksverzekering",
"readOnly": false,
"x-loket-db-field": "Loket.SoortConceptWerknemer.IsGemoedsbezwaardVolksverzekering",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"isGemoedsbezwaardEmployeeInsurance": {
"type": [
"boolean",
"null"
],
"example": true,
"description": "Gemoedsbezwaard Werknemerverzekering",
"readOnly": false,
"x-loket-db-field": "Loket.SoortConceptWerknemer.IsGemoedsbezwaardWerknemerverzekering",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"namePayslip": {
"type": [
"string",
"null"
],
"description": "Name that is visible on payslips for the employment",
"example": "Steve Jobs",
"maxLength": 34,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.NaamLoonstrook",
"x-loket-implementation": "Als ingevoerde waag is leeg of bestaat uit alleen spaties > NULL voor de database"
},
"calculateWorkingHours": {
"type": [
"boolean",
"null"
],
"example": true,
"description": "Automatically calculate working hours for the employment if the option automatically calculate hours is selected for a given period.",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Completeren",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"essMutationSet": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "References to a specified set of payrollcomponents that are to accessible via ESS for employee mutations\n\n`essMutationSet` is a metadata field within the werkgever/provider context. Possible values can be managed by the user. ",
"readOnly": false,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.ExportsetID"
},
"value": {
"type": "string",
"example": "Standaard",
"readOnly": true,
"x-loket-db-field": "Loket.WerkgeverExportSet",
"x-loket-implementation1": "Waarde -1 staat voor standaard ik weet echter niet of deze in de codetabel voorkomt mogelijk wordt deze door de GUI toegevoegd."
}
}
},
"exemptionInsuranceObligation": {
"type": "object",
"format": "metadata",
"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)",
"x-loket-implementation": "De 0 heeft hier een betekenis dus moet teruggegeven worden in de metadata en response",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.CodeUitzondering"
},
"value": {
"type": "string",
"example": "Geen uitzondering.",
"readOnly": true,
"x-loket-db-field": "dbo.ctCodeUitzondering"
}
}
},
"firstDayNotification": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Indicates whether first-day notification (EersteDagsMelding) is applicable for the employment",
"readOnly": false,
"x-loket-db-field": "Loket.SoortConceptWerknemer.EersteDagsMelding",
"x-loket-implementation": " In de API vertalen we dit alsvolgt: 0 = null, 1 = true, 2 = false"
},
"sendMdvNotification": {
"type": [
"boolean",
"null"
],
"example": true,
"description": "Indicate if a Mdv (melding dienstverband) should be send.",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.MdvMeldingAanmaken",
"x-loket-comment": "De waarde van dit veld is niet meer te bewerken nadat een dienstverband is aangemaakt."
},
"periodPayGradeAdjustment": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 2,
"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’.",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.PeriodeSalarisPeriodiek",
"x-loket-implementation": "als NULL dan 0 voor database"
},
"signalPayGradeAdjustment": {
"type": "boolean",
"example": false,
"description": "Indicates whether signaling regarding salary scale adjustments are enabled for the employment",
"readOnly": false,
"x-loket-db-field": "Loket.Conceptwerknemer.SalarisschaalSignaleren",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"typeOfParticipation": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The type of participation (aard van deelnemerschap) is only applicable in case the person related to this employment is eligible for pension",
"x-loket-implementation": "als NULL dan 0 voor database",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.AardDeelnemerschap"
},
"value": {
"type": "string",
"example": "n.vt.",
"readOnly": true,
"x-loket-db-field": "dbo.ctAardDeelnemerschap"
}
}
},
"valueOfParticipation": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The value of participation (waarde van deelnemerschap) is only applicable in case the person related to this employment is eligible for pension",
"x-loket-implementation": "als NULL dan 0 voor database",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.WaardeDeelnemerschap"
},
"value": {
"type": "string",
"example": "n.v.t.",
"readOnly": true,
"x-loket-db-field": "dbo.ctWaardeDeelnemerschap"
}
}
},
"professionCode": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 4,
"description": "A code field for a profession.",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Beroep"
},
"deviatingCLATaxReturn": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 2,
"description": "CLA (CAO) code in case of a deviating CLA for tax returns .",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.CAOUWV"
},
"participation55plusRegulationUWV": {
"type": "boolean",
"example": false,
"description": "Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Deelname55Plus",
"x-loket-implementation": "In de database is dit een numeriek veld. In de API vertalen we dit alsvolgt: 1 = true, 2 = false"
},
"emailLeaveRequest": {
"type": [
"string",
"null"
],
"description": "Recipient e-mail adress for notification in case of leave requests.",
"example": "api@loket.nl",
"maxLength": 255,
"readOnly": false,
"x-loket-implementation": "indien leeg of spaties > NULL voor database"
},
"writtenEmploymentContract": {
"type": "boolean",
"example": true,
"description": "Dit the employment and employer make a written contract?",
"readOnly": false
}
}
},
"workingHours-2": {
"type": "object",
"properties": {
"shift": {
"type": "object",
"format": "metadata",
"description": "The shift determines the full-time hours and bonus percentage.\n\n`shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.",
"x-loket.implementation": "loket.ConceptWerknemer.Ploeg is een ID die verwijst naar ulsa.ploeg . Er zit overerving en tijdsgebonden logica aan de ploeg vast dus moet er goed gekeken worden (zoals het nu werkt in loket.nl) welke ulsa.ploeg.uren, ulsa.ploeg.percentage worden teruggegeven op basis van ulsa.ploeg.JaarId en ulsa.ploeg.verloningsPeriodeId (en start en eind datum van de loket.werktijd regel)",
"properties": {
"shiftNumber": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the shift. ",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Ploeg",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. let wel op dat het ID meerdere malen voor kan komen in ULSa omdat het daar uniek is samen met verlongingsperiodeID"
},
"fullTimeHoursPerWeek": {
"type": "number",
"example": 40,
"description": "The full time hours for an employment that is linked to this shift.",
"minimum": 0.01,
"maximum": 99,
"readOnly": true,
"x-loket-db-field": "Ulsa.Ploeg.Uren"
},
"bonusPercentage": {
"type": "number",
"example": 12,
"description": "The bonus percentage used in wage calculations for the hours made in this shift. ",
"minimum": 0.01,
"maximum": 99,
"readOnly": true,
"x-loket-db-field": "ulsa.ploeg.percentage"
}
}
},
"deviatingHoursPerWeek": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 32,
"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.",
"minimum": 0.01,
"maximum": 99,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.AfwijkendAantalUrenPerWeek",
"x-loket-implementation": "Indien de waarde gelijk is aan 0 een NULL teruggeven",
"x-loket-implementation2": "Minimum 0.01 is zodat er niet numerieke 0 kan worden opgevoerd door de gebruiker van de API",
"x-loket-implementation3": "Indien calculateUsingWorkPattern.deviatingDaysAndHours op true AND enddate=null; dan berekenen dit veld. [som aantal uren in workPattern] /2 , afronden op 2 decimalen"
},
"deviatingSvDaysPerPeriod": {
"type": [
"number",
"null"
],
"example": 32,
"description": "Sv (social insurance) days are normally calculated by hours per shift, this optional field is used to register a deviating value. ",
"minimum": 1,
"maximum": 23,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.AfwijkendAantalDagenPerWeek",
"x-loket-implementation": "Indien de waarde gelijk is aan 0 een NULL teruggeven",
"x-loket-implementation2": "Minimum 1 is zodat er niet numerieke 0 kan worden opgevoerd door de gebruiker van de API",
"x-loket-implementation3": "Indien calculateUsingWorkPattern.deviatingDaysAndHours op true AND endDate=null; dan berekenen dit veld. Indien 4-weken verloning; [aantal velden in workPattern met n uren != 0 ]*2 . Else; [aantal velden in workPattern met n uren != 0 ] * 26 / 12"
},
"averageParttimeFactor": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,4})?$",
"example": 37.5,
"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",
"minimum": 0.0001,
"maximum": 999.9999,
"readOnly": false
},
"regularWorkPattern": {
"type": "boolean",
"example": true,
"description": "When the employee works the same amount of hours per day every week, then the workpattern is regular. ",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.RegelmatigArbeidspatroon"
},
"flexibleHoursContract": {
"type": [
"object",
"null"
],
"description": "The field indicates the type of flexible contract. If not applicable, please set to NULL.",
"x-loket-implementation": "in db 0 ; in API NULL",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": false,
"x-loket-db-field": "loket.conceptwerknemer.FlexibelUrenContract"
},
"value": {
"type": "string",
"example": "n.v.t.",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctFlexibelUrenContract.omschrijving"
}
}
},
"contractCode": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "This field is specialy made for convenience stores. The field is the type of contract.\n\n`contractCode` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.ContractCodeID omzetten naar GUID vanuit Loket.ContractCode.ExternID"
},
"code": {
"type": "integer",
"format": "int32",
"example": 1022,
"readOnly": true,
"x-loket-db-field": "Loket.ContractCode.Code"
},
"description": {
"type": "string",
"example": "SLA-PT-met toeslagen ATW (88)",
"readOnly": true,
"x-loket-db-field": "Loket.ContractCode.Omschrijving"
}
}
},
"calculateUsingWorkPattern": {
"type": "object",
"description": "Indications in this objects determine whether specific values should be calculated based on the bi-weekly workPattern (specified in the `workPattern` object).",
"properties": {
"leaveHours": {
"type": "boolean",
"example": true,
"description": "Indicates whether then leave balances (verlof) are to be calculated based on the workpattern.",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.BerekenenVerlofEenhedenViaRooster"
},
"hoursBrokenPeriod": {
"type": "boolean",
"example": false,
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.BerekenenUrenGebrokenPeriodeViaRooster"
},
"hoursPeriod": {
"type": "boolean",
"example": false,
"description": "Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods. ",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.BerekenenUrenPeriodeViaRooster"
},
"daysDailyRate": {
"type": "boolean",
"example": false,
"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. ",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.DagenDagvergoedingViaRooster"
},
"deviatingDaysAndHours": {
"type": "boolean",
"example": false,
"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)!",
"readOnly": false,
"x-loket-db-field": "Loket.Werktijd.AfwijkendeDagenUrenViaRooster"
}
}
},
"workPattern": {
"x-loket-implementation1": "Indien object !=null EN tenminste 1 veld heeft niet de numerieke waarde 0; dan record aanmaken/ wijzigen in Loket.WerktijdRooster. Let op; uniek op combinatie werkgever, persoon, dienstverband EN werktijdID.",
"x-loket-implementation2": "Indien object = null ; dan geen nieuw record aanmaken in Loket.WerktijdRooster.",
"x-loket-implementation3": "Let op! Als null wordt opgegeven, dient een eventueel bestaand record in Loket.WerktijdRooster te worden verwijderd.",
"x-loket-comment": "We voegen de volgende validatie toe; \"tenminste 1 van de velden in het workPattern object moet niet gelijk zijn aan 0. Als geen data, zet dan het bovenliggende object op NULL.\"",
"type": [
"object",
"null"
],
"description": "The applicable work pattern for a period of 2 weeks can be stored in this object. Each field contains the number of work hours for that day in the 2-week period.
Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0)
Each field represent the number of hours the employee normally works on that day.\n",
"properties": {
"oddWeeks": {
"type": "object",
"properties": {
"monday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenMaandag"
},
"tuesday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenDinsdag"
},
"wednesday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 4,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenWoensdag"
},
"thursday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 7.5,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenDonderdag"
},
"friday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 4,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenVrijdag"
},
"saturday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenZaterdag"
},
"sunday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenZondag"
}
}
},
"evenWeeks": {
"type": "object",
"properties": {
"monday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenMaandag"
},
"tuesday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenDinsdag"
},
"wednesday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenWoensdag"
},
"thursday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenDonderdag"
},
"friday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 2,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenVrijdag"
},
"saturday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenZaterdag"
},
"sunday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenZondag"
}
}
}
}
}
}
},
"wage-3": {
"type": "object",
"properties": {
"grossWage": {
"type": [
"number",
"null"
],
"format": "double",
"example": 23,
"description": "The gross wage for the employee\n",
"minimum": 1,
"maximum": 1000000,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Basisloon",
"x-loket-implementation": "In het geval van een 0 NULL teruggeven"
},
"grossWageType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates whether the `grossWage` is an hourly wage or a periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in wagePeriodType.\n",
"x-loket-implementation": "In het geval dat grossWage NULL is dit veld ook op NULL stellen",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.BasisloonEenheid"
},
"value": {
"type": "string",
"example": "hourly",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisloonEenheid"
}
}
},
"netWage": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Net wage for the employment\n",
"minimum": 1,
"maximum": 1000000,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Nettoloon",
"x-loket-implementation": "In het geval van een 0 NULL teruggeven"
},
"netWageType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates whether the net wage is an hourly wage or a periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in the payroll administration resource.\n",
"x-loket-implementation": "In het geval dat netWage NULL is dit veld ook op NULL stellen",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "loket.ConceptWerknemer.NettoloonEenheid"
},
"value": {
"type": "string",
"example": "hourly",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisloonEenheid"
}
}
},
"payScale": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "A pay scale (also known as a salary structure) is a system that determines how much an employee is to be paid as a wage or salary, based on one or more factors such as the employee\"s level, rank or status within the employer\"s organization, the length of time that the employee has been employed, and the difficulty of the specific work performed. After selecting a pay scale a pay grade needs to be selected to determine the actual wage. Only works with `grossWage`. The value of `grossWage` will be updated server side after the submit.\n\n`payScale` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "loket.Beloning.Salarisschaal"
},
"value": {
"type": "string",
"example": "Glastuinbouw maand, Loongebouw A",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Ulsa.Salarisschaal",
"x-loket-implementation": "Dit veld is ADM specifiek en bij het ophalen moet ook gekeken worden naar welke waardes voor de administratie beschikbaar zijn."
}
}
},
"payGrade": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The pay grade indicates on what level (cel) of the paygrade the employment is. The level is multi dimensional where the description indicates both the level and for example the number of years of service within the given level. \n\n`payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "loket.Beloning.SalarisschaalCelID"
},
"value": {
"type": "string",
"example": "Schaal B1, 15 jaar",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "ulsa.SalarisschaalCel",
"x-loket-implementation": "Dit veld is ADM specifiek en bij het ophalen moet ook gekeken worden naar welke waardes voor de administratie beschikbaar zijn."
}
}
},
"applyPayGrade": {
"type": [
"boolean",
"null"
],
"readOnly": false,
"example": true,
"description": "Apply pay grade indicates that after submitting the record the server will replace the value of `grossWage` with the value represented by the selected `payGrade`. A pay grade contains time based values, the value that is active on the `start date` of the record will be selected. \n",
"x-loket-implementation": "De GUI past de salarisschaal cel alleen toe als de waarde van salarisschaal, schaalcel of toepassen salarisschaal gewijzigd wordt. Met de API willen we dat als applyPayGrade op true staat het basisloon altijd voor overschreven met de waarde van paygrade. De waarde die geselecteerd moet worden is de waarde die actief is op de start datum van de belonings regel.",
"x-loket-db-field": "loket.Beloning.SalarisschaalToepassen"
}
}
},
"organizationalEntity-3": {
"type": "object",
"properties": {
"function": {
"type": "object",
"format": "metadata",
"description": "The function of the employment.\n\n`function` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.FunctieID en dan in loket.functie het externId ophalen"
},
"description": {
"type": "string",
"example": "Directeur",
"readOnly": true,
"x-loket-db-field": "Loket.Functie.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.Functie bevat de functies voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
},
"group": {
"type": "string",
"example": "internal",
"readOnly": true,
"x-loket-db-field": "Loket.Functie.functiegroup",
"x-loket-implementation": "Let op: de tabel Loket.Functie bevat de functies voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
},
"deviatingFunctionGroup": {
"type": [
"string",
"null"
],
"example": "9A",
"description": "The deviating functiongroup description of the employment.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Functiegroep"
},
"deviatingFunctionDescription": {
"type": [
"string",
"null"
],
"example": "Directeur",
"description": "The deviating function description of the employment. This description deviates from the value of the `function` field.",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Functieomschrijving"
},
"standardFunction": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The standard (cao)function of the employment.\n\n`standardFunction` is a metadata field within the payroll administration context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.StandaardFunctieID"
},
"value": {
"type": "string",
"example": "Administrateur",
"readOnly": true,
"x-loket-db-field": "Ulsa.Standaardfunctie.Omschrijving",
"x-loket-implementation": "Let op: de tabel Ulsa.StandaardFunctie bevat de standaard functies voor alle werkgevers,loonmodellen en cao's. Filteren op (ulsa) werkgever is dus noodzakelijk."
},
"code": {
"type": [
"string",
"null"
],
"example": "A21",
"minLength": 1,
"maxLength": 6,
"readOnly": true,
"x-loket-db-field": "Ulsa.Standaardfunctie.code",
"x-loket-implementation": "Let op: de tabel Ulsa.StandaardFunctie bevat de standaard functies voor alle werkgevers,loonmodellen en cao's. Filteren op (ulsa) werkgever is dus noodzakelijk."
},
"category": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "loket.Standaardfunctie.categorie"
}
}
},
"department": {
"type": "object",
"format": "metadata",
"description": "The department of the employment.\n\n`department` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Afdeling omzetten naar guid"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.Afdeling.code"
},
"description": {
"type": "string",
"example": "Verkoop",
"readOnly": true,
"x-loket-db-field": "Loket.Afdeling.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.Afdeling bevat de afdelingen voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
},
"distributionUnit": {
"type": "object",
"format": "metadata",
"description": "Distribution unit, used in several reports and the \"basic wage journal\" functionality. Commonly used as a cost center. \n\n`distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user. \n",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "Loket.VerdelingsEenheid.ExternId"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.nummer"
},
"description": {
"type": "string",
"example": "Sales",
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.Omschrijving"
}
}
},
"placeOfEmployment": {
"type": [
"string",
"null"
],
"example": "Amsterdam office",
"description": "The place of employment (standplaats) for the employment.",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Standplaats"
},
"internalTelephoneExtensionNumber": {
"type": [
"string",
"null"
],
"example": "0133031600",
"description": "The phone extention number for the employment.",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.InternTelefoonnummer"
}
}
},
"socialSecurity-3": {
"type": "object",
"properties": {
"isInsuredForSicknessBenefitsAct": {
"type": "boolean",
"example": false,
"description": "Will contributions for the Sickness Benefits Act (ZW) be payed for this employment",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.VerzekerdZW",
"x-loket-translation": "https://www.belastingdienst.nl/wps/wcm/connect/bldcontenten/belastingdienst/business/payroll_taxes/you_are_not_established_in_the_netherlands_are_you_required_to_withhold_payroll_taxes/when_you_are_going_to_withhold_payroll_taxes/calculating_payroll_taxes/calculating_employed_persons_insurance_contributions/own-risk_bearer_for_employed_persons_insurance_schemes"
},
"isInsuredForUnemploymentInsuranceAct": {
"type": "boolean",
"example": false,
"description": "Will contributions for the Unemployment Insurance Act (WW) be payed for this employment",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.VerzekerdWW",
"x-loket-translation": "https://www.belastingdienst.nl/wps/wcm/connect/bldcontenten/belastingdienst/business/payroll_taxes/you_are_not_established_in_the_netherlands_are_you_required_to_withhold_payroll_taxes/when_you_are_going_to_withhold_payroll_taxes/calculating_payroll_taxes/uniform_wage_concept_for_payroll_taxes"
},
"isInsuredForOccupationalDisabilityInsuranceAct": {
"type": "boolean",
"example": false,
"description": "Will contributions for the Occupational Disability Insurance Act (WAO) be payed for this employment",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.VerzekerdWAO",
"x-loket-translation": "https://www.belastingdienst.nl/wps/wcm/connect/bldcontenten/belastingdienst/business/payroll_taxes/you_are_not_established_in_the_netherlands_are_you_required_to_withhold_payroll_taxes/when_you_are_going_to_withhold_payroll_taxes/calculating_payroll_taxes/calculating_employed_persons_insurance_contributions/calculating_employed_persons_insurance_contributions"
},
"healthCareInsuranceActType": {
"type": "object",
"format": "metadata",
"description": "Indicates what type of Health Care Insurance Act (Zvw) is applicable for this employment",
"x-loket-translation": "https://www.belastingdienst.nl/wps/wcm/connect/bldcontenten/belastingdienst/business/payroll_taxes/you_are_not_established_in_the_netherlands_are_you_required_to_withhold_payroll_taxes/when_you_are_going_to_withhold_payroll_taxes/calculating_payroll_taxes/calculating_the_income-dependent_contribution_pursuant_to_the_health_care_insurance_act_zvw",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.SoortZvw"
},
"value": {
"type": "string",
"example": "(C/K) Wel verzekeringsplichtig, normaal tarief",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortZvw"
}
}
}
}
},
"fiscal-3": {
"type": "object",
"properties": {
"annualSalary": {
"type": "number",
"format": "double",
"example": 60000,
"description": "The fiscal annual salary",
"minimum": 0,
"maximum": 1000000000,
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Jaarloon"
},
"deviatingPayrollTaxTableColour": {
"type": "object",
"format": "metadata",
"description": "Indicates if there is a deviating payroll tax table is applicable (green vs white table)",
"x-loket-comment": "Indicatie of een afwijkende kleur loonheffingentabel moet worden toegepast. De default is in de inrichting van de salarisadministratie opgenomen.",
"x-loket-implementation": "als NULL dan 0 voor database",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.AfwijkendeKleurLB"
},
"value": {
"type": "string",
"example": "Werknemer belastingpl. en niet premiepl. WLZ",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctKleurLoonbelastingtabel"
}
}
},
"applyDayTables": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Indicates whether the value of the day table is used for the calculation of payroll tax",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.DagtabelToepassen"
},
"deviatingPayrollTaxPercentage": {
"type": [
"number",
"null"
],
"format": "double",
"example": 27.45,
"description": "Indicates a deviating payroll tax percentage is to be applied",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.AfwijkendLB_Percentage"
},
"applyDeviatingPayrollTaxPercentageOn": {
"type": "object",
"format": "metadata",
"description": "Indicates on what type of payroll calculation the deviating payroll tax percentage is applicable",
"x-loket-implementation": "als NULL dan 0 voor database",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.AfwijkendPercentageToepassen"
},
"value": {
"type": "string",
"example": "Afwijkend voor tabel- en tariefloon",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLoonbelastingPercentage"
}
}
},
"applyPayrollTaxDeduction": {
"type": "boolean",
"example": false,
"description": "Indicates whether payroll tax deduction is appliclable (loonheffingskorting)",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Loonheffingskorting"
},
"applyStudentDeduction": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Apply the \"Scholierenregeling\"",
"readOnly": false,
"x-loket-db-field": "Loket.ConceptWerknemer.Scholierenregeling"
},
"deviatingCalculationRulePayrollTax": {
"type": "object",
"format": "metadata",
"description": "Indicates if, while calculating payroll taxes and social security contributions, certain deviations are applicable. NL; Herleidingsregel",
"x-loket-comment": "https://www.belastingdienst.nl/wps/wcm/connect/bldcontentnl/themaoverstijgend/brochures_en_publicaties/herleidingsregels_april_2016",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Herleidingsregel"
},
"value": {
"type": "string",
"example": "Werknemer belastingpl. en niet premiepl. WLZ",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortLoonbelastingtabel"
}
}
},
"residentOf": {
"type": "object",
"format": "metadata",
"description": "Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.InwonerVan"
},
"value": {
"type": "string",
"example": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden",
"description": "Description of the type of document",
"maxLength": 80,
"readOnly": true,
"x-loket-db-field": "dbo.ctInwonerVan.Omschrijving"
}
}
}
}
},
"otherPayrollVariables-3": {
"type": "object",
"properties": {
"deviatingPremiumGroup": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.PremiegroepWachtgeld"
},
"value": {
"type": "string",
"example": "(12) Metaal- en technische bedrijfstakken",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctPremiegroepWachtgeld"
}
}
}
}
},
"createEmploymentObject": {
"type": "object",
"description": "The aggregated employment templates",
"readOnly": false,
"properties": {
"employeeData": {
"$ref": "#/components/schemas/employee-2"
},
"employmentData": {
"$ref": "#/components/schemas/employment-2"
},
"workingHoursData": {
"$ref": "#/components/schemas/workingHours-2"
},
"wageData": {
"$ref": "#/components/schemas/wage-3"
},
"organizationalEntityData": {
"$ref": "#/components/schemas/organizationalEntity-3"
},
"socialSecurityData": {
"$ref": "#/components/schemas/socialSecurity-3"
},
"fiscalData": {
"$ref": "#/components/schemas/fiscal-3"
},
"otherPayrollVariablesData": {
"$ref": "#/components/schemas/otherPayrollVariables-3"
}
}
},
"payrollAdministrationWithClaAndWageModel2019-12-16": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"description": "Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time)\n\n`payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true,
"x-loket-implementation": "Komt uit ulsa.werkgever ipv loket.verloning"
},
"name": {
"type": "string",
"example": "ABC accountants",
"description": "Name of the payroll administration",
"maxLength": 70,
"readOnly": true,
"x-loket-db-field": "Ulsa.Werkgever.Naam --> Dit is anders als wat we nu doen nu komt de naam uit loket.verloning.Omschrijving"
},
"clientNumber": {
"type": "integer",
"format": "int32",
"example": 1234,
"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.",
"readOnly": true,
"x-loket-db-field": "Ulsa.Werkgever.ClientNummer & Loket.Verloning.ClientNr",
"x-loket-implementation": "Het clientnummer is de verbinding tussen Ulsa.Werkgever en Loket.Verloning. Een waarde 0 in de database wordt als NULL teruggegeven in de API."
},
"description": {
"type": "string",
"example": "Bakker",
"description": "Description of the administration",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.Verloning.Omschrijving"
},
"cla": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "The CAO (CLA -> collective labor agrement) of the \"loonmodel\" the payroll administration is linked to.",
"properties": {
"value": {
"type": "string",
"example": "Agriculture",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "ulsa.ModelWerkgever.Omschrijving"
}
}
},
"wageModel": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "The \"loonmodel\" (this is a Loket term) the payroll administration inherits the payrolling configuration from. Deviating from the loonmodel configuration on payrol administration level is possible.\n`loonmodel` is a metadata field within the provider context. Possible values can be managed by the user.",
"properties": {
"value": {
"type": "string",
"example": "Foresting monthly payrolling",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "ulsa.modelwerkgever.naam"
}
}
}
}
},
"employmentWithClaAndWageModel2019-12-16": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"$ref": "#/components/schemas/startDate-4"
},
"historicalStartDate": {
"$ref": "#/components/schemas/historicalStartDate"
},
"commissionUntilDate": {
"$ref": "#/components/schemas/commissionUntilDate"
},
"endDate": {
"$ref": "#/components/schemas/endDate-5"
},
"endOfEmploymentReason": {
"$ref": "#/components/schemas/endOfEmploymentReason-2"
},
"endOfEmploymentReasonTaxAuthorities": {
"$ref": "#/components/schemas/endOfEmploymentReasonTaxAuthorities-2"
},
"endOfEmploymentDueToIllness": {
"$ref": "#/components/schemas/endOfEmploymentDueToIllness-2"
},
"firstDayNotification": {
"$ref": "#/components/schemas/firstDayNotification"
},
"payrollAdministration": {
"$ref": "#/components/schemas/payrollAdministrationWithClaAndWageModel2019-12-16"
},
"nonPayrollAdministration": {
"$ref": "#/components/schemas/nonPayrollAdministration2019-12-16"
},
"administration": {
"$ref": "#/components/schemas/administration2024-06-26"
},
"typeOfEmployee": {
"$ref": "#/components/schemas/typeOfEmployee"
},
"employmentCategoryType": {
"$ref": "#/components/schemas/employmentCategoryType"
},
"linkedEmployment": {
"$ref": "#/components/schemas/linkedEmployment"
},
"employmentDurationType": {
"$ref": "#/components/schemas/employmentDurationTypeVerion2019-12-16"
},
"startDateContractOfIndefiniteDuration": {
"$ref": "#/components/schemas/startDateContractOfIndefiniteDuration"
},
"employmentContractType": {
"$ref": "#/components/schemas/employmentContractType"
},
"vacationCoupons": {
"$ref": "#/components/schemas/vacationCoupons"
},
"sendToExternalParty": {
"$ref": "#/components/schemas/sendToExternalParty"
},
"deviatingCLAExternalParty": {
"$ref": "#/components/schemas/deviatingCLAExternalParty"
},
"deviatingCLATaxReturn": {
"$ref": "#/components/schemas/deviatingCLATaxReturn"
},
"incomeRelationshipNumber": {
"$ref": "#/components/schemas/incomeRelationshipNumber"
},
"employeeProfileId": {
"$ref": "#/components/schemas/employeeProfileId"
},
"professionCode": {
"$ref": "#/components/schemas/professionCode"
},
"exemptionWorkRelatedExpenseScheme": {
"$ref": "#/components/schemas/exemptionWorkRelatedExpenseScheme"
},
"exemptionPremiumWaiverMarginalLabour": {
"$ref": "#/components/schemas/exemptionPremiumWaiverMarginalLabour"
},
"typeOfParticipation": {
"$ref": "#/components/schemas/typeOfParticipation"
},
"valueOfParticipation": {
"$ref": "#/components/schemas/valueOfParticipation"
},
"wachtgeldOldRegulation": {
"$ref": "#/components/schemas/wachtgeldOldRegulation"
},
"participation55plusRegulationUWV": {
"$ref": "#/components/schemas/participation55plusRegulationUWV"
},
"essMutationSet": {
"$ref": "#/components/schemas/essMutationSet"
},
"exemptionInsuranceObligation": {
"$ref": "#/components/schemas/exemptionInsuranceObligation"
},
"specialIncomeRatio": {
"$ref": "#/components/schemas/specialIncomeRatio"
},
"emailLeaveRequest": {
"$ref": "#/components/schemas/emailLeaveRequest-2"
},
"temporaryTaxExemption": {
"$ref": "#/components/schemas/temporaryTaxExemption"
},
"periodPayGradeAdjustment": {
"$ref": "#/components/schemas/periodPayGradeAdjustment"
},
"signalPayGradeAdjustment": {
"$ref": "#/components/schemas/signalPayGradeAdjustment"
},
"commissionUntilDate1": {
"$ref": "#/components/schemas/commissionUntilDate1"
},
"commissionUntilDate2": {
"$ref": "#/components/schemas/commissionUntilDate2"
},
"commissionUntilDate3": {
"$ref": "#/components/schemas/commissionUntilDate3"
},
"commissionUntilDate4": {
"$ref": "#/components/schemas/commissionUntilDate4"
},
"commissionUntilDate5": {
"$ref": "#/components/schemas/commissionUntilDate5"
},
"commissionUntilDate6": {
"$ref": "#/components/schemas/commissionUntilDate6"
},
"isDirectorAndMajorShareholder": {
"$ref": "#/components/schemas/isDirectorAndMajorShareholder"
},
"isPreviousOwner": {
"$ref": "#/components/schemas/isPreviousOwner"
},
"isFamilyOfOwner": {
"$ref": "#/components/schemas/isFamilyOfOwner"
},
"isOnCallEmployment": {
"$ref": "#/components/schemas/isOnCallEmploymentVerion2019-12-16"
},
"hasOnCallAppearanceObligation": {
"$ref": "#/components/schemas/hasOnCallAppearanceObligation"
},
"isGemoedsbezwaardNationalInsurance": {
"$ref": "#/components/schemas/isGemoedsbezwaardNationalInsurance"
},
"isGemoedsbezwaardEmployeeInsurance": {
"$ref": "#/components/schemas/isGemoedsbezwaardEmployeeInsurance"
},
"isAnonymousEmployee": {
"$ref": "#/components/schemas/isAnonymousEmployee"
},
"cancellationPeriodEmployee": {
"$ref": "#/components/schemas/cancellationPeriodEmployee"
},
"cancellationPeriodEmployer": {
"$ref": "#/components/schemas/cancellationPeriodEmployer"
},
"cancellationPeriodTimeUnit": {
"$ref": "#/components/schemas/cancellationPeriodTimeUnit"
},
"cancellationNoticeDate": {
"$ref": "#/components/schemas/cancellationNoticeDate"
},
"startCancellationNoticePeriod": {
"$ref": "#/components/schemas/startCancellationNoticePeriod"
},
"payrollId": {
"$ref": "#/components/schemas/payrollId"
},
"namePayslip": {
"$ref": "#/components/schemas/namePayslip"
},
"calculateWorkingHours": {
"$ref": "#/components/schemas/calculateWorkingHours"
},
"writtenEmploymentContract": {
"$ref": "#/components/schemas/writtenEmploymentContract"
}
}
},
"employmentResponseWithClaAndWageModel2019-12-16": {
"allOf": [
{
"type": "object",
"properties": {
"employee": {
"$ref": "#/components/schemas/employeeBasic"
}
}
},
{
"type": "object",
"$ref": "#/components/schemas/employmentWithClaAndWageModel2019-12-16"
}
]
},
"employmentCategoryTypeFieldsObject": {
"type": "object",
"properties": {
"employmentCategoryType": {
"type": "object",
"format": "metadata",
"description": "A selection of special pre defined employment-types for the employment. NL: Type dienstverband",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Ouderschapsverlof",
"readOnly": true
}
}
},
"linkedEmployment": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
}
}
},
"employeeProfile": {
"type": "object",
"properties": {
"activationDate": {
"type": "string",
"format": "date",
"example": "2021-01-01",
"description": "The date on which the profile should be activated.",
"readOnly": false
},
"employeeProfileId": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"description": "The Id of the employeeProfile. If not provided, the employeeProfile which is set at employment level, is used.",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.WerknemerProfielID"
}
}
},
"employeeProfileResponse": {
"type": "object",
"properties": {
"employmentFunds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The ID's of the created entities"
}
},
"employmentFundsABP": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The ID's of the created entities"
}
},
"basesForCalculation": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The ID's of the created entities"
}
},
"benefitsAndDeductions": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The ID's of the created entities"
}
}
}
},
"deleteEmploymentInformation": {
"type": "object",
"properties": {
"isEmployed": {
"type": "boolean",
"example": false,
"description": "Indicates whether the employment is employed.",
"readOnly": true
},
"isIncludedInPayroll": {
"type": "boolean",
"example": false,
"description": "Indicates whether the employment is...",
"readOnly": true
},
"hasMeldingen": {
"type": "boolean",
"example": false,
"description": "Indicates whether the employment has...",
"readOnly": true
},
"HasHealthInsuranceContract": {
"type": "boolean",
"example": false,
"description": "Indicates whether the employment has...",
"readOnly": true
},
"hasMdvNotifications": {
"type": "boolean",
"example": false,
"description": "Indicates whether the employment has...",
"readOnly": true
},
"hasDocument": {
"type": "boolean",
"example": false,
"description": "Indicates whether the employment has...",
"readOnly": true
},
"hasWNLAndSingleEmployment": {
"type": "boolean",
"example": false,
"description": "Indicates whether the employment has...",
"readOnly": true
},
"hasESSAndSingleEmployment": {
"type": "boolean",
"example": false,
"description": "Indicates whether the employment has...",
"readOnly": true
},
"hasMultipleEmployments": {
"type": "boolean",
"example": false,
"description": "Indicates whether the employee to which the employment belongs, has multiple employments. If False the person will also be deleted.",
"readOnly": true
},
"hasPayrollRunStatusOpen": {
"type": "boolean",
"example": false,
"description": "Indicates whether the administration of the employment has...",
"readOnly": true
},
"hasEmployerUserEmployeeLink": {
"type": "boolean",
"example": false,
"description": "Indicates whether the employee is linked to an employer user.",
"readOnly": true
},
"isIncludedInPayrollTaxreturn": {
"type": "boolean",
"example": false,
"description": "Indicates whether the employment is...",
"readOnly": true
},
"isIncludedInPensionDeclaration": {
"type": "boolean",
"example": false,
"description": "Indicates whether the employment is...",
"readOnly": true
},
"isIncludedInUpaPensionDeclaration": {
"type": "boolean",
"example": false,
"description": "Indicates whether the employment is...",
"readOnly": true
},
"isIncludedInApgPensionDeclaration": {
"type": "boolean",
"example": false,
"description": "Indicates whether the employment is...",
"readOnly": true
}
}
},
"employmentTermination20181231": {
"properties": {
"endDate": {
"type": "string",
"format": "date",
"example": "2018-10-23",
"description": "The date on which the employment ends (=last day of the employment).\n",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.DatumUitDienst"
},
"endOfEmploymentReason": {
"type": "object",
"format": "metadata",
"description": "The reason for the end of the employment.\n\n__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. \n\nPlease set this field to 8 (Other) unless one of the following integrations is used for this employment\n * UPA-pensioenaangifte\n * Cordares\n * APG-pensioenaangifte\n * Achmea",
"readOnly": false,
"x-loket-implementation": "Indien de waarde 0 (n.v.t) is het element NULL maken.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the reason for the end of the employment.",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.RedenEindeDienstverband"
},
"value": {
"type": "string",
"example": "VUT",
"description": "The description of the reason for the end of the employment.",
"readOnly": true,
"x-loket-db-field": "dbo.ctRedenEindeDienstverband.Omschrijving"
}
}
},
"endOfEmploymentDueToIllness": {
"type": "boolean",
"example": false,
"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.\n",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.ZiekUitDienst",
"x-loket-implementation": "In de database is dit een non-nullable veld. In de API vertalen we dit alsvolgt: 0 = null, 1 = true, 2 = false. Alleen in te vullen indien endDate gevuld is. "
},
"createMdvEntry": {
"type": "boolean",
"example": false,
"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`.\n\nNext 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).\n",
"readOnly": false,
"x-loket-db-field": "wordt niet opgeslagen in DB, echter er wordt een record gecreeerd in MdvMelding tabel"
},
"endOfEmploymentReasonTaxAuthorities": {
"type": "object",
"format": "metadata",
"description": "The reason for the end of the employment as specified by the Dutch Tax authorties.\n\n__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.\n",
"readOnly": false,
"x-loket-implementation": "Indien de waarde 0 (n.v.t) is het element NULL maken.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the reason for the end of the employment.",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.RedenEindeDienstverbandAangifte"
},
"value": {
"type": "string",
"example": "Opzegging door de werkgever binnen de proeftijd.",
"description": "The description of the reason for the end of the employment.",
"readOnly": true,
"x-loket-db-field": "dbo.ctRedenEindeDienstverbandAangifte.Omschrijving"
}
}
}
}
},
"employmentTermination20180101": {
"properties": {
"endDate": {
"type": "string",
"format": "date",
"example": "2018-10-23",
"description": "The date on which the employment ends (=last day of the employment).\n",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.DatumUitDienst"
},
"endOfEmploymentReason": {
"type": "object",
"format": "metadata",
"description": "The reason for the end of the employment. Mandatory if endDate is filled, else leave empty.\n",
"readOnly": false,
"x-loket-implementation": "Indien de waarde 0 (n.v.t) is het element NULL maken. Alleen in te vullen indien endDate gevuld is.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.RedenEindeDienstverband"
}
}
},
"endOfEmploymentDueToIllness": {
"type": "boolean",
"example": false,
"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.\n",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.ZiekUitDienst",
"x-loket-implementation": "In de database is dit een non-nullable veld. In de API vertalen we dit alsvolgt: 0 = null, 1 = true, 2 = false. Alleen in te vullen indien endDate gevuld is. "
},
"createMdvEntry": {
"type": "boolean",
"example": false,
"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`.\n\nNext 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).\n",
"readOnly": false,
"x-loket-db-field": "wordt niet opgeslagen in DB, echter er wordt een record gecreeerd in MdvMelding tabel"
}
}
},
"employmentStartDate": {
"properties": {
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this employment starts (=first day of the employment).\n",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.DatumInDienst"
}
}
},
"payrollDataPatchCollective": {
"properties": {
"employmentId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"payrollPeriod": {
"type": "object",
"format": "metadata",
"x-loket-implementation": "De twee waardes kunnen vertaald worden naar Loket.Loontransactie.PeriodeID dan zal er wel voor gezorgd moeten worden dat periode altijd uit 2 cijfers bestaat het is nu een int dus mogelijk moet periode een number worden",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period in which the payroll data is to be processed\n",
"example": 2017,
"minimum": 2000,
"maximum": 9999,
"readOnly": false,
"x-loket-db-field": "eerste 4 cijfers van Loket.Loontransactie.PeriodeID"
},
"periodNumber": {
"type": "integer",
"format": "int32",
"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.\n",
"example": 1,
"minimum": 1,
"maximum": 53,
"readOnly": false,
"x-loket-db-field": "Laatste 2 cijfers van Loket.Loontransactie.PeriodeID",
"x-loket-implementation": "Bij het updaten/inserten van dit veld eventueel een leading 0 toevoegen aan het periodenummer als deze kleiner is dan 10. Zodat PeriodeID in de database altijd 6 cijfers bevat met als formatting yyyymm, bijvoorbeeld 201807"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period to which the payroll period data applies\n",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period to which the payroll period data applies\n",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
}
}
},
"shift": {
"type": "object",
"format": "metadata",
"description": "The shift determines the full-time hours and bonus percentage.\n",
"properties": {
"shiftNumber": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the shift. Loket supports a maximum of 15 shifts per payroll administration.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.Ploeg.PloegId",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. Let wel op dat het ID meerdere malen voor kan komen in Ulsa omdat het daar uniek is in combinatie met verlongingsperiodeID"
},
"fullTimeHoursPerWeek": {
"type": "number",
"example": 40,
"description": "The full time hours for an employment that is linked to this shift.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.Ploeg.Uren"
},
"bonusPercentage": {
"type": "number",
"example": 12,
"description": "The bonus percentage used in wage calculations for the hours made in this shift.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.Ploeg.Percentage"
}
}
},
"payslipType": {
"type": "object",
"format": "metadata",
"description": "The type of payslip (as defined by the Dutch tax authorities)\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.Strook"
},
"value": {
"type": "string",
"example": "Bijzonder tarief strook",
"readOnly": true,
"x-loket-db-field": "dbo.ctStrook.Omschrijving"
}
}
},
"payslipText": {
"type": [
"string",
"null"
],
"example": "Additional payslip for bonus",
"description": "A custom text to be displayed on the payslip.\n",
"minLength": 1,
"maxLength": 25,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.TekstStrook"
},
"distributionUnit": {
"type": "object",
"format": "metadata",
"description": "Distribution unit (verdelingseenheid), used in several reports and the \"basic wage journal\" functionality. Commonly used as a cost center.\n",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "Loket.VerdelingsEenheid.ExternId"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.Nummer"
},
"description": {
"type": "string",
"example": "Sales",
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.Omschrijving"
}
}
},
"costCenter": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost center on which the payroll period data for this record will be booked for the ledger.\n",
"x-loket-implementation": "er zit overerving in de logica voor het ophalen van de waardes van de kostenplaats. null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.KostenplaatsID",
"x-loket-implementation": "Kan geen GUID zijn vanwege de overerving. De code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "SAL073",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Sales Den Bosch",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"costUnit": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost unit on which the data for this record will be booked for the ledger\n",
"x-loket-implementation": "er zit overerving in de logica voor het ophalen van de waardes van de kostendrager. null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.KostenDragerID",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. en code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "01",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Cars",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"payrollComponents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payrollComponent": {
"type": "object",
"format": "metadata",
"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.
Please note: Business rules may differ per component! Understanding these business rules and corresponding validations requires functional knowledge of Loket.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know it by heart.\n",
"readOnly": false,
"x-loket-db-field": "Loket.LoontransactieMutatie.ComponentID"
},
"description": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Categorie"
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true,
"x-loket-db-field": "dbo.ctCategorie.omschrijving"
}
}
},
"deductionOrPayment": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"x-loket-implementation": "Indien Ulsa.Component.BetalingInhouding de waarde 0 heeft NULL teruggeven.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.BetalingInhouding"
},
"value": {
"type": "string",
"example": "Betaling",
"readOnly": true,
"x-loket-db-field": "dbo.ctBetalingInhouding"
}
}
},
"canBeSupplemented": {
"type": "boolean",
"example": false,
"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.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.ComponentAlgemeen.AanvullendMogelijk",
"x-loket-implementation": "1 (ja) = true en 2 (nee) = false"
}
}
},
"value": {
"type": [
"number",
"null"
],
"example": 144,
"description": "Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules). \n\nRule of thumb: Amounts must be between -100,000,000 and 100,000,000, hours cannot be negative, and must be less than 1000.\n\n \nPlease 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 (!).\n\n\n 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.\n",
"readOnly": false
},
"isSupplement": {
"type": "boolean",
"example": false,
"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).\n\n* 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.\n\n* 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.\n\nThis boolean can only be set to `true` in components for which `payrollComponent.canBesupplemented = true`.\n",
"readOnly": false,
"x-loket-implementation": "Wanneer de waarde true is, dient de mutatie opgeslagen te worden met attribuut Aanvullend (code 2 in dbo.ctLoontransactie). Wanneer de waarde false is && value == 0 dan dient de mutatie opgeslagen te worden met atttribuut Nul (code 1 in dbo.ctLoontransactie). Wanneer de waarde false is && value != 0 dan dient de mutatie opgeslagen te worden met attribuut Vervangend (code 0 in dbo.ctLoontransactie)."
}
}
}
}
}
},
"payrollDataGetPut2018-01-01": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"payrollPeriod": {
"type": "object",
"format": "metadata",
"readOnly": true,
"x-loket-implementation": "De twee waardes kunnen vertaald worden naar Loket.Loontransactie.PeriodeID dan zal er wel voor gezorgd moeten worden dat periode altijd uit 2 cijfers bestaat het is nu een int dus mogelijk moet periode een number worden",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period in which the payroll data is to be processed\n",
"example": 2017,
"minimum": 2000,
"maximum": 9999,
"readOnly": true,
"x-loket-db-field": "eerste 4 cijfers van Loket.Loontransactie.PeriodeID"
},
"periodNumber": {
"type": "integer",
"format": "int32",
"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.\n",
"example": 1,
"minimum": 1,
"maximum": 53,
"readOnly": true,
"x-loket-db-field": "Laatste 2 cijfers van Loket.Loontransactie.PeriodeID",
"x-loket-implementation": "Bij het updaten/inserten van dit veld eventueel een leading 0 toevoegen aan het periodenummer als deze kleiner is dan 10. Zodat PeriodeID in de database altijd 6 cijfers bevat met als formatting yyyymm, bijvoorbeeld 201807"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period to which the payroll period data applies\n",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period to which the payroll period data applies\n",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
}
}
},
"shift": {
"type": "object",
"format": "metadata",
"description": "The shift determines the full-time hours and bonus percentage.\n",
"properties": {
"shiftNumber": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the shift. Loket supports a maximum of 15 shifts per payroll administration.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.Ploeg.PloegId",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. Let wel op dat het ID meerdere malen voor kan komen in Ulsa omdat het daar uniek is in combinatie met verlongingsperiodeID"
},
"fullTimeHoursPerWeek": {
"type": "number",
"example": 40,
"description": "The full time hours for an employment that is linked to this shift.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.Ploeg.Uren"
},
"bonusPercentage": {
"type": "number",
"example": 12,
"description": "The bonus percentage used in wage calculations for the hours made in this shift.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.Ploeg.Percentage"
}
}
},
"payslipType": {
"type": "object",
"format": "metadata",
"description": "The type of payslip (as defined by the Dutch tax authorities)\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.Loontransactie.Strook"
},
"value": {
"type": "string",
"example": "Bijzonder tarief strook",
"readOnly": true,
"x-loket-db-field": "dbo.ctStrook.Omschrijving"
}
}
},
"payslipText": {
"type": [
"string",
"null"
],
"example": "Additional payslip for bonus",
"description": "A custom text to be displayed on the payslip.\n",
"minLength": 1,
"maxLength": 25,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.TekstStrook"
},
"distributionUnit": {
"type": "object",
"format": "metadata",
"description": "Distribution unit, used in several reports and the \"basic wage journal\" functionality. Commonly used as a cost center.\n",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "Loket.VerdelingsEenheid.ExternId"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.Nummer"
},
"description": {
"type": "string",
"example": "Sales",
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.Omschrijving"
}
}
},
"costCenter": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost center on which the payroll period data for this record will be booked for the ledger.\n",
"x-loket-implementation": "er zit overerving in de logica voor het ophalen van de waardes van de kostenplaats. null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.KostenplaatsID",
"x-loket-implementation": "Kan geen GUID zijn vanwege de overerving. De code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "SAL073",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Sales Den Bosch",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"costUnit": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost unit on which the data for this record will be booked for the ledger\n",
"x-loket-implementation": "er zit overerving in de logica voor het ophalen van de waardes van de kostendrager. null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.KostenDragerID",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. en code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "01",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Cars",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"payrollComponents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payrollComponent": {
"type": "object",
"format": "metadata",
"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.
Please note: Business rules may differ per component! Understanding these business rules and corresponding validations requires functional knowledge of Loket.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know it by heart.\n",
"readOnly": false,
"x-loket-db-field": "Loket.LoontransactieMutatie.ComponentID"
},
"description": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Categorie"
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true,
"x-loket-db-field": "dbo.ctCategorie.omschrijving"
}
}
},
"deductionOrPayment": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"x-loket-implementation": "Indien Ulsa.Component.BetalingInhouding de waarde 0 heeft NULL teruggeven.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.BetalingInhouding"
},
"value": {
"type": "string",
"example": "Betaling",
"readOnly": true,
"x-loket-db-field": "dbo.ctBetalingInhouding"
}
}
},
"canBeSupplemented": {
"type": "boolean",
"example": false,
"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.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.ComponentAlgemeen.AanvullendMogelijk",
"x-loket-implementation": "1 (ja) = true en 2 (nee) = false"
}
}
},
"value": {
"type": "number",
"example": 144,
"description": "Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules).\n",
"readOnly": false
},
"isSupplement": {
"type": "boolean",
"example": false,
"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).\n\n* 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.\n\n* 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.\n\nThis boolean can only be set to `true` in components for which `payrollComponent.canBesupplemented = true`.\n",
"readOnly": false,
"x-loket-implementation": "Wanneer de waarde true is, dient de mutatie opgeslagen te worden met attribuut Aanvullend (code 2 in dbo.ctLoontransactie). Wanneer de waarde false is && value == 0 dan dient de mutatie opgeslagen te worden met atttribuut Nul (code 1 in dbo.ctLoontransactie). Wanneer de waarde false is && value != 0 dan dient de mutatie opgeslagen te worden met attribuut Vervangend (code 0 in dbo.ctLoontransactie)."
}
}
}
}
}
},
"payrollDataPost2018-01-01": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"payrollPeriod": {
"type": "object",
"format": "metadata",
"x-loket-implementation": "De twee waardes kunnen vertaald worden naar Loket.Loontransactie.PeriodeID dan zal er wel voor gezorgd moeten worden dat periode altijd uit 2 cijfers bestaat het is nu een int dus mogelijk moet periode een number worden",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period in which the payroll data is to be processed\n",
"example": 2017,
"minimum": 2000,
"maximum": 9999,
"readOnly": false,
"x-loket-db-field": "eerste 4 cijfers van Loket.Loontransactie.PeriodeID"
},
"periodNumber": {
"type": "integer",
"format": "int32",
"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.\n",
"example": 1,
"minimum": 1,
"maximum": 53,
"readOnly": false,
"x-loket-db-field": "Laatste 2 cijfers van Loket.Loontransactie.PeriodeID",
"x-loket-implementation": "Bij het updaten/inserten van dit veld eventueel een leading 0 toevoegen aan het periodenummer als deze kleiner is dan 10. Zodat PeriodeID in de database altijd 6 cijfers bevat met als formatting yyyymm, bijvoorbeeld 201807"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period to which the payroll period data applies\n",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period to which the payroll period data applies\n",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
}
}
},
"shift": {
"type": "object",
"format": "metadata",
"description": "The shift determines the full-time hours and bonus percentage.\n\n`shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"shiftNumber": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the shift. Loket supports a maximum of 15 shifts per payroll administration.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.Ploeg.PloegId",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. Let wel op dat het ID meerdere malen voor kan komen in Ulsa omdat het daar uniek is in combinatie met verlongingsperiodeID"
},
"fullTimeHoursPerWeek": {
"type": "number",
"example": 40,
"description": "The full time hours for an employment that is linked to this shift.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.Ploeg.Uren"
},
"bonusPercentage": {
"type": "number",
"example": 12,
"description": "The bonus percentage used in wage calculations for the hours made in this shift.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.Ploeg.Percentage"
}
}
},
"payslipType": {
"type": "object",
"format": "metadata",
"description": "The type of payslip (as defined by the Dutch tax authorities)\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.Strook"
},
"value": {
"type": "string",
"example": "Bijzonder tarief strook",
"readOnly": true,
"x-loket-db-field": "dbo.ctStrook.Omschrijving"
}
}
},
"payslipText": {
"type": [
"string",
"null"
],
"example": "Additional payslip for bonus",
"description": "A custom text to be displayed on the payslip.\n",
"minLength": 1,
"maxLength": 25,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.TekstStrook"
},
"distributionUnit": {
"type": "object",
"format": "metadata",
"description": "Distribution unit, used in several reports and the \"basic wage journal\" functionality. Commonly used as a cost center.\n\n`distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "Loket.VerdelingsEenheid.ExternId"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.Nummer"
},
"description": {
"type": "string",
"example": "Sales",
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.Omschrijving"
}
}
},
"costCenter": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost center on which the payroll period data for this record will be booked for the ledger.\n\n`costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-implementation": "er zit overerving in de logica voor het ophalen van de waardes van de kostenplaats. null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.KostenplaatsID",
"x-loket-implementation": "Kan geen GUID zijn vanwege de overerving. De code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "SAL073",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Sales Den Bosch",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"costUnit": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost unit on which the data for this record will be booked for the ledger\n\n`costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-implementation": "er zit overerving in de logica voor het ophalen van de waardes van de kostendrager. null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.KostenDragerID",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. en code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "01",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Cars",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"payrollComponents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payrollComponent": {
"type": "object",
"format": "metadata",
"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.
Please note; Business rules may differ per component! Understanding these business rules and corresponding validations requires functional knowledge of Loket.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know it by heart.\n",
"readOnly": false,
"x-loket-db-field": "Loket.LoontransactieMutatie.ComponentID"
},
"value": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Categorie"
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true,
"x-loket-db-field": "dbo.ctCategorie.omschrijving"
}
}
},
"deductionOrPayment": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"x-loket-implementation": "Indien Ulsa.Component.BetalingInhouding de waarde 0 heeft NULL teruggeven.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.BetalingInhouding"
},
"value": {
"type": "string",
"example": "Betaling",
"readOnly": true,
"x-loket-db-field": "dbo.ctBetalingInhouding"
}
}
},
"canBeSupplemented": {
"type": "boolean",
"example": false,
"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.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.ComponentAlgemeen.AanvullendMogelijk",
"x-loket-implementation": "1 (ja) = true en 2 (nee) = false"
}
}
},
"value": {
"type": "number",
"example": 144,
"description": "Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules).\n",
"readOnly": false
},
"isSupplement": {
"type": "boolean",
"example": false,
"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).\n\n* 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.\n\n* 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.\n\nThis boolean can only be set to `true` in components for which `payrollComponent.canBesupplemented = true`.\n",
"readOnly": false,
"x-loket-implementation": "Wanneer de waarde true is, dient de mutatie opgeslagen te worden met attribuut Aanvullend (code 2 in dbo.ctLoontransactie). Wanneer de waarde false is && value == 0 dan dient de mutatie opgeslagen te worden met atttribuut Nul (code 1 in dbo.ctLoontransactie). Wanneer de waarde false is && value != 0 dan dient de mutatie opgeslagen te worden met attribuut Vervangend (code 0 in dbo.ctLoontransactie)."
}
}
}
}
}
},
"payrollDataPatch2018-01-01": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"payrollPeriod": {
"type": "object",
"format": "metadata",
"x-loket-implementation": "De twee waardes kunnen vertaald worden naar Loket.Loontransactie.PeriodeID dan zal er wel voor gezorgd moeten worden dat periode altijd uit 2 cijfers bestaat het is nu een int dus mogelijk moet periode een number worden",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period in which the payroll data is to be processed\n",
"example": 2017,
"minimum": 2000,
"maximum": 9999,
"readOnly": false,
"x-loket-db-field": "eerste 4 cijfers van Loket.Loontransactie.PeriodeID"
},
"periodNumber": {
"type": "integer",
"format": "int32",
"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.\n",
"example": 1,
"minimum": 1,
"maximum": 53,
"readOnly": false,
"x-loket-db-field": "Laatste 2 cijfers van Loket.Loontransactie.PeriodeID",
"x-loket-implementation": "Bij het updaten/inserten van dit veld eventueel een leading 0 toevoegen aan het periodenummer als deze kleiner is dan 10. Zodat PeriodeID in de database altijd 6 cijfers bevat met als formatting yyyymm, bijvoorbeeld 201807"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period to which the payroll period data applies\n",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period to which the payroll period data applies\n",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
}
}
},
"shift": {
"type": "object",
"format": "metadata",
"description": "The shift determines the full-time hours and bonus percentage.\n",
"properties": {
"shiftNumber": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the shift. Loket supports a maximum of 15 shifts per payroll administration.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.Ploeg.PloegId",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. Let wel op dat het ID meerdere malen voor kan komen in Ulsa omdat het daar uniek is in combinatie met verlongingsperiodeID"
},
"fullTimeHoursPerWeek": {
"type": "number",
"example": 40,
"description": "The full time hours for an employment that is linked to this shift.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.Ploeg.Uren"
},
"bonusPercentage": {
"type": "number",
"example": 12,
"description": "The bonus percentage used in wage calculations for the hours made in this shift.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.Ploeg.Percentage"
}
}
},
"payslipType": {
"type": "object",
"format": "metadata",
"description": "The type of payslip (as defined by the Dutch tax authorities)\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.Strook"
},
"value": {
"type": "string",
"example": "Bijzonder tarief strook",
"readOnly": true,
"x-loket-db-field": "dbo.ctStrook.Omschrijving"
}
}
},
"payslipText": {
"type": [
"string",
"null"
],
"example": "Additional payslip for bonus",
"description": "A custom text to be displayed on the payslip.\n",
"minLength": 1,
"maxLength": 25,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.TekstStrook"
},
"distributionUnit": {
"type": "object",
"format": "metadata",
"description": "Distribution unit (verdelingseenheid), used in several reports and the \"basic wage journal\" functionality. Commonly used as a cost center.\n",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "Loket.VerdelingsEenheid.ExternId"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.Nummer"
},
"description": {
"type": "string",
"example": "Sales",
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.Omschrijving"
}
}
},
"costCenter": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost center on which the payroll period data for this record will be booked for the ledger.\n",
"x-loket-implementation": "er zit overerving in de logica voor het ophalen van de waardes van de kostenplaats. null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.KostenplaatsID",
"x-loket-implementation": "Kan geen GUID zijn vanwege de overerving. De code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "SAL073",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Sales Den Bosch",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"costUnit": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost unit on which the data for this record will be booked for the ledger\n",
"x-loket-implementation": "er zit overerving in de logica voor het ophalen van de waardes van de kostendrager. null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.KostenDragerID",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. en code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "01",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Cars",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"processingMethod": {
"type": [
"string",
"null"
],
"enum": [
"overwrite",
"doNotOverwrite",
"addUp"
],
"description": "The processing method determines how components that already have a value are handled.",
"readOnly": false
},
"payrollComponents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payrollComponent": {
"type": "object",
"format": "metadata",
"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.
Please note: Business rules may differ per component! Understanding these business rules and corresponding validations requires functional knowledge of Loket.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know it by heart.\n",
"readOnly": false,
"x-loket-db-field": "Loket.LoontransactieMutatie.ComponentID"
},
"description": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Categorie"
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true,
"x-loket-db-field": "dbo.ctCategorie.omschrijving"
}
}
},
"deductionOrPayment": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"x-loket-implementation": "Indien Ulsa.Component.BetalingInhouding de waarde 0 heeft NULL teruggeven.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.BetalingInhouding"
},
"value": {
"type": "string",
"example": "Betaling",
"readOnly": true,
"x-loket-db-field": "dbo.ctBetalingInhouding"
}
}
},
"canBeSupplemented": {
"type": "boolean",
"example": false,
"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.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.ComponentAlgemeen.AanvullendMogelijk",
"x-loket-implementation": "1 (ja) = true en 2 (nee) = false"
}
}
},
"value": {
"type": [
"number",
"null"
],
"example": 144,
"description": "Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules). \n\nPlease 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 (!).\n\n\n 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.\n",
"readOnly": false
},
"isSupplement": {
"type": "boolean",
"example": false,
"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).\n\n* 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.\n\n* 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.\n\nThis boolean can only be set to `true` in components for which `payrollComponent.canBesupplemented = true`.\n",
"readOnly": false,
"x-loket-implementation": "Wanneer de waarde true is, dient de mutatie opgeslagen te worden met attribuut Aanvullend (code 2 in dbo.ctLoontransactie). Wanneer de waarde false is && value == 0 dan dient de mutatie opgeslagen te worden met atttribuut Nul (code 1 in dbo.ctLoontransactie). Wanneer de waarde false is && value != 0 dan dient de mutatie opgeslagen te worden met attribuut Vervangend (code 0 in dbo.ctLoontransactie)."
}
}
}
}
}
},
"benefitsAndDeductionsGetAndPut2018-01-01": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "1995-05-21",
"description": "The start date for the information in the record.\n\nA (linked chain)[./#section/Data/Date-chains] per payroll component is maintained within this resource.\n",
"readOnly": false,
"x-loket-db-field": "Loket.toeslag.DatumIngang"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The end date for the information in the record.\n",
"readOnly": false,
"x-loket-db-field": "Loket.toeslag.DatumEinde"
},
"payrollComponent": {
"type": "object",
"format": "metadata",
"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.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"readOnly": true,
"x-loket-implementation": "Dit veld is in de interface read only bij het wijzigen.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component.\n",
"readOnly": false,
"x-loket-db-field": "Loket.toeslag.ComponentID"
},
"description": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)",
"x-loket-implementation": "Omdat hier met datums en niet met verloningsperiodes gewerkt wordt moet de beschrijving van het actieve jaar gebruikt worden."
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. There are six viable categories for this resource:
7, Bruto vergoeding volgens tabel
9, Netto vergoeding
30, Bedrag per eenheid
12, Bruto inhouding
13, Netto inhouding
11, Fiscale bijtelling
17, Afdrachtvermindering
\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Categorie"
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true,
"x-loket-db-field": "dbo.ctCategorie.omschrijving"
}
}
},
"deductionOrPayment": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"x-loket-implementation": "Indien Ulsa.Component.BetalingInhouding de waarde 0 heeft NULL teruggeven.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.BetalingInhouding"
},
"value": {
"type": "string",
"example": "Betaling",
"readOnly": true,
"x-loket-db-field": "dbo.ctBetalingInhouding"
}
}
}
}
},
"value": {
"type": "number",
"example": 50.87,
"description": "The value for the selected payroll component.
\n",
"minimum": 0.01,
"maximum": 99999.99,
"readOnly": false
}
}
},
"benefitsAndDeductionsPost2018-01-01": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "1995-05-21",
"description": "The start date for the information in the record.\n\nA (linked chain)[./#section/Data/Date-chains] per payroll component is maintained with this resource.\n",
"readOnly": false,
"x-loket-db-field": "Loket.toeslag.DatumIngang"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The end date for the information in the record.\n",
"readOnly": false,
"x-loket-db-field": "Loket.toeslag.DatumEinde"
},
"payrollComponent": {
"type": "object",
"format": "metadata",
"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.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-implementation": "Dit veld is in de interface read only bij het wijzigen.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component.\n",
"readOnly": false,
"x-loket-db-field": "Loket.toeslag.ComponentID"
},
"description": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)",
"x-loket-implementation": "Omdat hier met datums en niet met verloningsperiodes gewerkt wordt moet de beschrijving van het actieve jaar gebruikt worden."
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Categorie"
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true,
"x-loket-db-field": "dbo.ctCategorie.omschrijving"
}
}
},
"deductionOrPayment": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"x-loket-implementation": "Indien Ulsa.Component.BetalingInhouding de waarde 0 heeft NULL teruggeven.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.BetalingInhouding"
},
"value": {
"type": "string",
"example": "Betaling",
"readOnly": true,
"x-loket-db-field": "dbo.ctBetalingInhouding"
}
}
}
}
},
"value": {
"type": "number",
"example": 50.87,
"description": "The value for the selected payroll component.\n",
"minimum": 0.01,
"maximum": 99999.99,
"readOnly": false
}
}
},
"BenefitsAndDeductionsImportData": {
"properties": {
"clientNumber": {
"type": "integer",
"format": "int32",
"example": 20720,
"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).",
"readOnly": true
},
"payrollEmployeeNumber": {
"type": "integer",
"format": "int32",
"example": 202,
"description": "The number of the employment in relation to the payroll administration.",
"readOnly": true
},
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 156,
"description": "The employee number to uniquely identify an employee within an employer\n",
"readOnly": false
},
"formattedName": {
"type": "string",
"example": "Jong, I",
"description": "preformated user name for displaying. \\\\\", \\\"\\\\\" \\\"\\",
"readOnly": true
},
"startDate": {
"type": "string",
"format": "date",
"example": "2023-11-01",
"description": "The start date of the benefits / deductions",
"readOnly": false
},
"payrollComponentKey": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component.\n",
"readOnly": false
},
"payrollComponentDescription": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true
},
"value": {
"type": [
"number",
"null"
],
"format": "double",
"description": "The value of the benefit / deduction.\n",
"example": 3500,
"minimum": 0.01,
"maximum": 99999.99,
"readOnly": false
}
}
},
"benefitsAndDeductionsCollectivePut": {
"properties": {
"employmentId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"benefitAndDeductionId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"endDate": {
"type": "string",
"format": "date",
"example": "1995-05-21",
"description": "The end date for the information in the record.\n",
"readOnly": false
}
}
},
"benefitsAndDeductionsCollectivePost": {
"properties": {
"employmentId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"startDate": {
"type": "string",
"format": "date",
"example": "1995-05-21",
"description": "The start date for the information in the record.\n\nA (linked chain)[./#section/Data/Date-chains] is maintained within this resource.\n",
"readOnly": false
},
"value": {
"type": [
"number",
"null"
],
"format": "double",
"example": 80,
"description": "The value for the component\n",
"minimum": 0.01,
"maximum": 99999.99,
"readOnly": false
},
"payrollComponent": {
"type": "object",
"format": "metadata",
"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.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"readOnly": false,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component.\n",
"readOnly": false
}
}
}
}
},
"signalPaygradeAdjustment": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (GUID/UUID) of the employment",
"readOnly": false
},
"action": {
"type": "string",
"enum": [
"enable",
"disable"
],
"description": "The action to perform.",
"readOnly": false
}
},
"required": [
"id",
"action"
]
},
"wageProjectionInput": {
"type": "object",
"properties": {
"deviations": {
"type": [
"object",
"null"
],
"readOnly": false,
"description": "This endpoint can only be used for employments that are already known in the Loket 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",
"properties": {
"startDate": {
"type": "string",
"format": "date",
"example": "1995-05-21",
"description": "The start date for the information in the record.",
"readOnly": false
},
"percentageChange": {
"type": [
"number",
"null"
],
"example": 25,
"description": "The percentage change used in wage calculations.",
"minimum": 0.01,
"maximum": 99.99,
"readOnly": false
},
"hoursPerWeek": {
"type": [
"number",
"null"
],
"example": 37.5,
"description": "The hours per week used in wage calculations.",
"minimum": 1,
"maximum": 99.99,
"readOnly": false
}
}
},
"calculateUsingNextYearsValues": {
"type": [
"boolean",
"null"
],
"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,
"readOnly": false
}
}
},
"payrollResults": {
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id",
"x-loket-implementation": "Loket.Dienstverband.ExternId"
},
"payrollPeriods": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payrollPeriod": {
"format": "metadata",
"type": "object",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period the record relates to",
"example": 2017,
"readOnly": false,
"x-loket-db-field": "Ulsa.LoonaangifteBericht.Jaar"
},
"periodNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "The period number of the payroll period the record relates to",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Ulsa.LoonaangifteBericht.Periode"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period for which the tax return message was created",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period for which the tax return message was created",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"testYear": {
"type": "boolean",
"example": false,
"description": "Indicates whether the payroll periode is part of a test year.\n\nIn 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. \nPlease 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.",
"readOnly": true,
"x-loket-db-field": "af te leiden uit de jaarinrichting van de administratie Ulsa.Jaar"
}
}
},
"payslipTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payslipType": {
"type": "object",
"format": "metadata",
"description": "The type of payslip on which underlying payroll run results will be booked. This is either normaal or bijzonder tarief.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Strook",
"x-loket-comment": "LET OP; hier gaat het om ulsaCode maar we willen teruggeven de loketCode (zie ctStrook)"
},
"value": {
"type": "string",
"example": "Normaal strook",
"readOnly": true
}
}
},
"payrollComponentResults": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payrollComponent": {
"type": "object",
"format": "metadata",
"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.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart.\n",
"readOnly": false
},
"value": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc. \n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true
}
}
},
"column": {
"type": "object",
"format": "metadata",
"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.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 6,
"readOnly": true,
"x-loket-implementation": "deze waarde kan 0 zijn met een betekenis, dus; niet vertalen naar NULL !"
},
"value": {
"type": "string",
"example": "Sociaalplichtig loon",
"readOnly": true
}
}
},
"costsEmployer": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true
},
"value": {
"type": "string",
"example": "+",
"readOnly": true
}
}
}
}
},
"value": {
"type": "number",
"example": 40,
"description": "Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this.",
"readOnly": true,
"x-loket-comment": "Maximum precision = 2"
},
"valueSpecialTariff": {
"type": "number",
"example": 144,
"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.",
"readOnly": true,
"x-loket-comment": "Maximum precision = 2"
}
}
}
}
}
}
}
}
}
}
}
},
"claWageProjectionInput": {
"type": "object",
"properties": {
"grossWage": {
"type": "number",
"format": "double",
"minimum": 0.01,
"maximum": 999999.99,
"example": 3500,
"description": "The grosswage per payroll period",
"readOnly": false
},
"hoursPerWeek": {
"type": "number",
"format": "double",
"example": 24.5,
"description": "The hours per week te be used in the wage calculation. \n\nPlease note that currently this endpoint will always calculate as if the hours provided are full time hours.",
"minimum": 0.01,
"maximum": 99.99,
"readOnly": false
},
"dateOfBirth": {
"type": "string",
"format": "date",
"example": "1995-05-21",
"description": "The date of birth\n",
"readOnly": false
},
"holidayAllowance": {
"type": [
"object",
"null"
],
"readOnly": false,
"properties": {
"percentage": {
"type": "number",
"example": 8,
"description": "The percentage for the holiday bonus (vakantiegeld)",
"minimum": 0,
"maximum": 999.999999,
"readOnly": false
},
"resultPayrollComponent": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 82,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart.\n",
"readOnly": false
}
}
}
}
},
"additionalPayrollPeriod": {
"type": [
"object",
"null"
],
"readOnly": false,
"properties": {
"percentage": {
"type": "number",
"example": 8,
"description": "The percentage for the additional payroll period wage the employment receives (13e maand / extra periode loon / winstuitkering)",
"minimum": 0,
"maximum": 999.999999,
"readOnly": false
},
"resultPayrollComponent": {
"type": "object",
"format": "metadata",
"description": "A payroll component. These components are the core of the wage calculation software.\n\n`payrollComponents` is a metadata field within the payroll administration, loonmodel and cao context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 83,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart.\n",
"readOnly": false
}
}
}
}
},
"applyPayrollTaxDeduction": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Indicates whether payroll tax deduction is to be applied (loonheffingskorting)",
"readOnly": false
},
"companyCar": {
"type": [
"object",
"null"
],
"properties": {
"fiscalAddition": {
"type": "number",
"example": 345.87,
"description": "The fiscal addition to the wage for the given `fiscalAdditionPeriod` for the lease/company car\n",
"minimum": 0.01,
"maximum": 999999.99,
"readOnly": false
},
"fiscalAdditionPeriod": {
"type": "string",
"description": "Periodicity of the `fiscalAddition`",
"enum": [
"Year",
"payrollPeriod"
],
"readOnly": false
}
}
},
"deductions": {
"type": [
"object",
"null"
],
"properties": {
"net": {
"type": [
"number",
"null"
],
"example": 50.87,
"description": "The net deduction from the wage\n",
"minimum": 0.01,
"maximum": 999999.99,
"readOnly": false
},
"gross": {
"type": [
"number",
"null"
],
"example": 50.87,
"description": "The gross deduction from the wage\n",
"minimum": 0.01,
"maximum": 999999.99,
"readOnly": false
}
}
},
"payments": {
"type": [
"object",
"null"
],
"properties": {
"net": {
"type": [
"number",
"null"
],
"example": 50.87,
"description": "The net payment added to the wage\n",
"minimum": 0.01,
"maximum": 999999.99,
"readOnly": false
},
"gross": {
"type": [
"number",
"null"
],
"example": 50.87,
"description": "The gross payment added to the wage\n",
"minimum": 0.01,
"maximum": 999999.99,
"readOnly": false
}
}
},
"deviations": {
"type": [
"object",
"null"
],
"readOnly": false,
"description": "Deviations allow the user to calculate the difference between the current wage and the wage after certain deviations.\nIf no deviations are required set the object to NULL",
"properties": {
"grossWagePercentageChange": {
"type": [
"number",
"null"
],
"example": 25,
"description": "The percentage change used in wage calculations.",
"minimum": 0.01,
"maximum": 99.99,
"readOnly": false
},
"hoursPerWeek": {
"type": [
"number",
"null"
],
"example": 37.5,
"description": "The hours per week used in wage calculations.",
"minimum": 1,
"maximum": 99.99,
"readOnly": false
}
}
},
"calculateUsingNextYearsValues": {
"type": [
"boolean",
"null"
],
"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,
"readOnly": false
}
}
},
"claData": {
"type": "object",
"properties": {
"collectiveLaborAgreement": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Voorbeeld B.V.",
"description": "Name of the company",
"maxLength": 70,
"readOnly": true
},
"baseForCalculation": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"description": "The key for the baseForCalculation",
"readOnly": true
},
"description": {
"type": "string",
"example": "vakantie toeslag",
"maxLength": 50,
"readOnly": true
},
"resultPayrollComponent": {
"type": "object",
"format": "metadata",
"description": "A payroll component. These components are the core of the wage calculation software.\n`payrollComponents` is a metadata field within the payroll administration, loonmodel and cao context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 82,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart.\n",
"readOnly": true
},
"description": {
"type": "string",
"example": "Output, VAKANTIE TOESL",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true
}
}
},
"baseType": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the base type\n\n 0 = nvt\n\n 1\t=\tVakantiebijslag\n \n 2\t=\tExtra periode salaris\n",
"readOnly": true
},
"value": {
"type": "string",
"example": "Vakantiebijslag",
"description": "The description baseType\n",
"maxLength": 14,
"readOnly": true
}
}
},
"percentage": {
"type": "number",
"example": 8,
"description": "The percentage",
"minimum": 0.000001,
"maximum": 999.999999,
"readOnly": true
}
}
}
},
"employments": {
"type": "array",
"items": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
}
},
"nextYear": {
"type": "object",
"properties": {
"available": {
"type": "boolean",
"description": "Are next payroll years values available yes or no ?",
"readOnly": true
},
"status": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the status of the values",
"readOnly": true
},
"value": {
"type": "string",
"example": "Definitive",
"description": "The status of the values",
"maxLength": 50,
"readOnly": true
}
}
},
"year": {
"type": "integer",
"format": "int32",
"description": "The year for which the numbers are available",
"example": 2017,
"readOnly": true
}
}
}
}
}
}
},
"collectiveLaborAgreement": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"example": "Voorbeeld B.V.",
"description": "Name of the company",
"maxLength": 70,
"readOnly": false
}
}
},
"employeeEducation": {
"type": "object",
"x-loket-db": "De velden zijn te vinden in loket.Opleiding",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"example": "HBO accountancy",
"description": "Name of the education",
"maxLength": 50,
"readOnly": false,
"x-loket-db-field": "Loket.Opleiding.Naam"
},
"typeOfEducation": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.",
"x-loket-implementation": "als NULL dan 0 voor database",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "loket.OpleidingSoort.OpleidingSoort omzetten naar guid"
},
"code": {
"type": "string",
"example": "WO",
"readOnly": true,
"x-loket-db-field": "Loket.OpleidingSoort.Code"
},
"description": {
"type": "string",
"example": "Wetenschappelijk",
"readOnly": true,
"x-loket-db-field": "Loket.OpleidingSoort.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.OpleidingSoort bevat de opleidingsoorten voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
},
"furtherIndication": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The futher indication of the education. `futher indication of the education` is a metadata field within the employer context. Possible values can be managed by the user. x-loket-implementation: als NULL dan 0 voor database",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "loket.OpleidingNadereAanduiding.OpleidingNadereAanduiding omzetten naar guid"
},
"code": {
"type": "string",
"example": "WO",
"readOnly": true,
"x-loket-db-field": "Loket.OpleidingNadereAanduiding.Code"
},
"description": {
"type": "string",
"example": "Wetenschappelijk",
"readOnly": true,
"x-loket-db-field": "Loket.OpleidingNadereAanduiding.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.OpleidingNadereAanduiding bevat de nadere aanduidingen voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
},
"educationLevel": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates the level of the education.",
"x-loket-implementation": "als NULL dan 0 voor database",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Opleiding.Niveau"
},
"value": {
"type": "string",
"example": "HBO",
"maxLength": 80,
"readOnly": true,
"x-loket-db-field": "ctOpleidingNiveau"
}
}
},
"startDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-01-01",
"description": "The date on which this education starts.",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false
},
"institute": {
"type": [
"object",
"null"
],
"properties": {
"Name": {
"type": "string",
"example": "Avans Hogeschool",
"description": "Name of the institute",
"maxLength": 70,
"readOnly": false,
"x-loket-db-field": "Loket.Opleiding.Naam"
},
"city": {
"type": [
"string",
"null"
],
"example": "Leiden",
"maxLength": 24,
"description": "City of the institute",
"readOnly": false,
"x-loket-db-field": "Loket.Opleiding.Plaatsnaam"
}
}
},
"hasDiploma": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates whether the employee has graduated.",
"x-loket-implementation": "als NULL dan 0 voor database",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Opleiding.Diploma"
},
"value": {
"type": "string",
"example": "Onbekend",
"maxLength": 80,
"readOnly": true,
"x-loket-db-field": "ctDiploma"
}
}
},
"yearOfDiploma": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1995,
"description": "Year in which the diploma was aquired",
"minimum": 1900,
"maximum": 2099,
"readOnly": false,
"x-loket-db-field": "Loket.Opleiding.JaarDiploma",
"x-loket-implemenation": "Rubriek wordt alfanumeriek opgeslagen in de database."
},
"endOfValidityDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2023-12-31",
"description": "The end date of the diploma validity . The date is up to and including.",
"readOnly": false
},
"employeeCosts": {
"type": [
"number",
"null"
],
"format": "double",
"example": 150,
"description": "The costs of the education for the employee\n",
"minimum": 0.01,
"readOnly": false,
"x-loket-db-field": "Loket.Opleiding.KostenWerknemer"
},
"employerCosts": {
"type": [
"number",
"null"
],
"format": "double",
"example": 850,
"description": "The costs of the education for the employer\n",
"minimum": 0.01,
"readOnly": false,
"x-loket-db-field": "Loket.Opleiding.KostenWerkgever"
},
"particularities": {
"type": [
"string",
"null"
],
"example": "Van de opleiding is alleen een certificaat verkregen",
"description": "Extra information about the education",
"maxLength": 4000,
"readOnly": false,
"x-loket-db-field": "Loket.Opleiding.Bijzonderheden"
}
}
},
"declarationObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"payrollComponent": {
"type": "object",
"format": "metadata",
"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. \n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 11,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know it by heart.\n",
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerMutatie.Component"
},
"description": {
"type": "string",
"example": "UREN TVT 130%",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
},
"deviatingDescription": {
"type": [
"string",
"null"
],
"example": "Uren tijd voor tijd 130%",
"description": "A longer and more user-friendly description of the payroll component.\n",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Ulsa.ComponentNaamAfwijkend (database view)"
},
"deductionOrPayment": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"x-loket-implementation": "Indien Ulsa.Component.BetalingInhouding de waarde 0 heeft NULL teruggeven.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.BetalingInhouding"
},
"value": {
"type": "string",
"example": "Betaling",
"readOnly": true,
"x-loket-db-field": "dbo.ctBetalingInhouding"
}
}
},
"routeType": {
"type": [
"object",
"null"
],
"readOnly": true,
"format": "metadata",
"description": "The route type determines how the route is calculate.\n\n__Note:__ NULL means route calculation is disabled",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Snelste",
"readOnly": true
}
}
}
}
},
"calculatedDistanceByRoutingService": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 8,
"description": "The value calulated by the routing service",
"minimum": 0.01,
"maximum": 99999999.99,
"readOnly": false
},
"numberOfUnits": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 8,
"description": "The number of units requested",
"minimum": 0.01,
"maximum": 99999999.99,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerMutatie.AantalEenheden"
},
"numberOfUnitsByAnalysis": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 8,
"description": "The number of units scanned by the azure document intelligence analysis (uses the total value from PostAnalyzeReceiptByEmploymentId response)",
"minimum": 0,
"maximum": 99999999.99
},
"declarationDate": {
"type": "string",
"format": "date",
"example": "2017-11-01",
"description": "The date to which the declaration is applicable. As requested by the employee.",
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerMutatie.Datum"
},
"declarationComment": {
"type": [
"string",
"null"
],
"description": "The comment left by the employee",
"example": "Overwerk project X",
"maxLength": 1000,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerMutatie.Omschrijving",
"x-loket-implementation": "Een lege string in de database wordt in de API teruggegeven als NULL."
},
"declarationStatus": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "The current status of the declaration\n\nThe status is changed by using the PATCH endpoint.\n1 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",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Loket.WerknemerMutatie.Status"
},
"value": {
"type": "string",
"example": "Open",
"readOnly": true,
"x-loket-db-field": "dbo.ctWerknemerMutatieStatus.Omschrijving"
}
}
},
"dateOfSubmissionByEmployee": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time the declaration was submitted",
"readOnly": true,
"x-loket-db-field": "Loket.WerknemerMutatie.DatumAangemaakt"
},
"dateOfLastChangeByEmployee": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time the declaration was last changed",
"readOnly": true,
"x-loket-db-field": "Loket.WerknemerMutatie.LaatstBijgewerktDoorWerknemer"
},
"processedInPayrollPeriod": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "If the declaration has been successfully processed then this object will show the payroll period for which a payrollPeriodData has been created.\n\nIf the declaration has not yet been processed, then the value of this object will be null.\n",
"readOnly": true,
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period\n",
"example": 2017,
"minimum": 2000,
"maximum": 9999,
"readOnly": true
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period\n",
"example": 1,
"minimum": 1,
"maximum": 53,
"readOnly": true,
"x-loket-db-field": "Laatste 2 cijfers van Loket.WerknemerMutatie.PeriodeID",
"x-loket-implementation": "Bij het updaten/inserten van dit veld eventueel een leading 0 toevoegen aan het periodenummer als deze kleiner is dan 10. Zodat PeriodeID in de database altijd 6 cijfers bevat met als formatting yyyymm, bijvoorbeeld 201807"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period\n",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period\n",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
}
}
},
"reasonForDeviatingFromCalculatedDistance": {
"type": [
"string",
"null"
],
"description": "The reason why the employee deviated form the calculated distance.",
"example": "There were some ongoing road works i had to get around",
"maxLength": 1000,
"readOnly": false
},
"route": {
"type": [
"array",
"null"
],
"description": "If applicable contains the addresses of stops used to calculate the route. The order of the items in the array is equal to the order of the route taken.",
"items": {
"properties": {
"pointOfInterest": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"type": [
"string",
"null"
],
"example": "Van Spaendonck Groep",
"description": "The name of the point of interest",
"maxLength": 1000,
"readOnly": false
}
}
},
"address": {
"type": "object",
"properties": {
"freeformAddress": {
"type": "string",
"description": "description of the address",
"example": "Reitseplein 1, 5037 AA Tilburg",
"maxLength": 1000,
"readOnly": false
},
"countryCode": {
"type": [
"string",
"null"
],
"example": "NL",
"description": "isocode of the country",
"minLength": 2,
"maxLength": 2,
"readOnly": false
}
}
},
"position": {
"type": "object",
"properties": {
"latitude": {
"description": "latitude for the address",
"example": 51.585996,
"pattern": "^(-?\\d{1,2})(\\.\\d{1,6})?$",
"type": "number",
"format": "double",
"minimum": -90,
"maximum": 90
},
"longitude": {
"description": "longitude for the address",
"example": 5.585996,
"pattern": "^(-?\\d{1,3})(\\.\\d{1,6})?$",
"type": "number",
"format": "double",
"minimum": -180,
"maximum": 180
}
}
}
}
}
}
}
},
"declarationsAuditTrail": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"status": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "The status after the action was performed",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Approved",
"readOnly": true
}
}
},
"performedBy": {
"$ref": "#/components/schemas/userBasicNotNullable"
},
"performedOn": {
"type": "string",
"format": "date-time",
"example": "2017-11-01",
"description": "The date-time to which the action was performed",
"readOnly": true
},
"comment": {
"type": [
"string",
"null"
],
"description": "The comment for the action",
"example": "Approved",
"maxLength": 4000,
"readOnly": true
}
}
},
"boundingRegionObject": {
"type": "array",
"readOnly": true,
"items": {
"minimum": 0,
"properties": {
"x": {
"type": "number",
"format": "float",
"example": 1,
"description": "x coordinate",
"readOnly": true
},
"y": {
"type": "number",
"format": "float",
"example": 456,
"description": "y coordinate",
"readOnly": true
}
}
}
},
"confidenceObject": {
"type": [
"number",
"null"
],
"format": "float",
"maximum": 1,
"minimum": 0,
"example": 0.73,
"description": "Indication of how certain the algorithm is about the result",
"readOnly": true
},
"receiptOcrResults": {
"properties": {
"confidence": {
"type": "number",
"example": 0.51,
"maximum": 1,
"minimum": 0,
"description": "Indication of how certain the algorithm is about the result",
"readOnly": true
},
"boundingRegion": {
"$ref": "#/components/schemas/boundingRegionObject"
},
"merchantName": {
"type": [
"object",
"null"
],
"properties": {
"value": {
"type": "string",
"description": "Name of the merchant",
"readOnly": true
},
"confidence": {
"$ref": "#/components/schemas/confidenceObject"
},
"boundingRegion": {
"$ref": "#/components/schemas/boundingRegionObject"
}
}
},
"total": {
"type": [
"object",
"null"
],
"properties": {
"value": {
"type": "number",
"example": 21.99,
"description": "total cost",
"readOnly": true
},
"confidence": {
"$ref": "#/components/schemas/confidenceObject"
},
"boundingRegion": {
"$ref": "#/components/schemas/boundingRegionObject"
}
}
},
"subTotal": {
"type": [
"object",
"null"
],
"properties": {
"value": {
"type": "number",
"example": 19.54,
"description": "sub cost",
"readOnly": true
},
"confidence": {
"$ref": "#/components/schemas/confidenceObject"
},
"boundingRegion": {
"$ref": "#/components/schemas/boundingRegionObject"
}
}
},
"totalTax": {
"type": [
"object",
"null"
],
"properties": {
"value": {
"type": "number",
"description": "total tax",
"example": 1.58,
"readOnly": true
},
"confidence": {
"$ref": "#/components/schemas/confidenceObject"
},
"boundingRegion": {
"$ref": "#/components/schemas/boundingRegionObject"
}
}
},
"transactionDate": {
"type": [
"object",
"null"
],
"properties": {
"value": {
"type": "string",
"format": "date",
"example": "2024-01-01",
"description": "Date of the transaction",
"readOnly": true
},
"confidence": {
"$ref": "#/components/schemas/confidenceObject"
},
"boundingRegion": {
"$ref": "#/components/schemas/boundingRegionObject"
}
}
},
"transactionTime": {
"type": "object",
"properties": {
"value": {
"type": "string",
"format": "time",
"example": "16:49:02",
"description": "Time of the transaction",
"readOnly": true
},
"confidence": {
"$ref": "#/components/schemas/confidenceObject"
},
"boundingRegion": {
"$ref": "#/components/schemas/boundingRegionObject"
}
}
},
"payrollComponent": {
"type": [
"object",
"null"
],
"properties": {
"componentId": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart. \n",
"readOnly": true
},
"name": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true
},
"deviatingDescription": {
"type": "string",
"example": "Uren tijd voor tijd 130%",
"description": "A longer and more user-friendly description of the payroll component.\n",
"maxLength": 50,
"readOnly": true
}
}
}
}
},
"WageImportData": {
"properties": {
"clientNumber": {
"type": "integer",
"format": "int32",
"example": 20720,
"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).",
"readOnly": true
},
"payrollEmployeeNumber": {
"type": "integer",
"format": "int32",
"example": 202,
"description": "The number of the employment in relation to the payroll administration.",
"readOnly": true
},
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 156,
"description": "The employee number to uniquely identify an employee within an employer\n",
"readOnly": false
},
"formattedName": {
"type": "string",
"example": "Jong, I",
"description": "preformated user name for displaying. \\\\\", \\\"\\\\\" \\\"\\",
"readOnly": true
},
"startDate": {
"type": "string",
"format": "date",
"example": "2023-11-01",
"description": "The start date of the Wage",
"readOnly": false
},
"grossWage": {
"type": [
"number",
"null"
],
"format": "double",
"example": 2300,
"description": "The gross wage for the employee\n",
"minimum": 0.01,
"maximum": 999999.99,
"readOnly": false
},
"grossWageTypeKey": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false
},
"netWage": {
"type": [
"number",
"null"
],
"format": "double",
"example": 2400,
"description": "Net wage for the employment\n",
"minimum": 0.01,
"maximum": 999999.99,
"readOnly": false,
"x-loket-db-field": "Loket.Beloning.Nettoloon",
"x-loket-implementation": "In het geval van een 0 NULL teruggeven"
},
"netWageTypeKey": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"employerCosts": {
"type": [
"number",
"null"
],
"format": "double",
"description": "The cost for the employer for this employee.\n",
"example": 3500,
"minimum": 0.01,
"maximum": 99999.99,
"readOnly": false
},
"employerCostsTypeKey": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
}
}
},
"wageCollective": {
"properties": {
"employmentId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"startDate": {
"type": "string",
"format": "date",
"example": "1995-05-21",
"description": "The start date for the information in the record.\n\nA (linked chain)[./#section/Data/Date-chains] is maintained within this resource.\n__Note__ It is possible to have no wage record.\n",
"readOnly": false
},
"grossWage": {
"type": [
"number",
"null"
],
"format": "double",
"example": 2300,
"description": "The gross wage for the employee\n",
"minimum": 0.01,
"maximum": 999999.99,
"readOnly": false
}
}
},
"minimumwage": {
"properties": {
"referenceDate": {
"type": "string",
"format": "date",
"example": "2024-05-21",
"description": "The reference date used to calculate the minimumwage\n",
"readOnly": true,
"x-loket-db-field": "Loket.Beloning.DatumIngang"
},
"payScale": {
"type": [
"object",
"null"
],
"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. \n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": -1,
"readOnly": false
}
}
},
"payGrade": {
"type": [
"object",
"null"
],
"description": "The pay grade indicates on what level (cel) of the paygrade the employment is. \n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 18,
"readOnly": true
},
"amount": {
"type": "number",
"format": "double",
"example": 2040.37,
"readOnly": true
}
}
}
}
},
"costPerHour": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"payrollPeriods": {
"type": "object",
"description": "The period of the kpu record.",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"example": 202001,
"description": "The id for this specific payroll period.",
"readOnly": false
},
"year": {
"type": "integer",
"format": "int32",
"description": "The payroll year",
"example": 2020,
"readOnly": true
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period number of the payroll period",
"example": 1,
"readOnly": true
},
"startDate": {
"type": "string",
"format": "date",
"description": "The first day of the payroll period",
"example": "2020-01-01",
"readOnly": true
},
"endDate": {
"type": "string",
"format": "date",
"description": "The last day of the payroll period",
"example": "2020-01-31",
"readOnly": true
}
}
},
"costPerHour": {
"type": "number",
"format": "double",
"example": 21.2,
"description": "The cost per hour for the employment\n",
"readOnly": false,
"minimum": -99999.99,
"maximum": 99999.99
},
"registrationMethod": {
"type": "object",
"description": "This object indicates how the cost per hour was aquired. Possible values are Verloning, Schatting and Handmatig",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the registrationmethod ('Wijze van aanmaken'). ",
"readOnly": true,
"x-loket-db-field": "Loket.WerknemerKpu.WijzeVanAanmaken"
},
"value": {
"type": "string",
"example": "Verloning",
"description": "The description of registrationmethod ('Wijze van aanmaken'). Possible values are \"Verloning\", \"Schatting\" and \"Handmatig\"",
"readOnly": true,
"x-loket-db-field": "dbo.ctWerknemerKpuWijzeVanAanmaak.Omschrijving"
}
}
}
}
},
"costPerHourPut": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"payrollPeriods": {
"type": "object",
"description": "The period of the kpu record.",
"readOnly": true,
"properties": {
"id": {
"type": "integer",
"format": "int32",
"example": 202001,
"description": "The id for this specific payroll period.",
"readOnly": true
},
"year": {
"type": "integer",
"format": "int32",
"description": "The payroll year",
"example": 2020,
"readOnly": true
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period number of the payroll period",
"example": 1,
"readOnly": true
},
"startDate": {
"type": "string",
"format": "date",
"description": "The first day of the payroll period",
"example": "2020-01-01",
"readOnly": true
},
"endDate": {
"type": "string",
"format": "date",
"description": "The last day of the payroll period",
"example": "2020-01-31",
"readOnly": true
}
}
},
"costPerHour": {
"type": "number",
"format": "double",
"example": 21.2,
"description": "The cost per hour for the employment\n",
"readOnly": false,
"minimum": -99999.99,
"maximum": 99999.99
},
"registrationMethod": {
"type": "object",
"description": "This object indicates how the cost per hour was aquired. Possible values are Verloning, Schatting and Handmatig",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the registrationmethod ('Wijze van aanmaken'). ",
"readOnly": true,
"x-loket-db-field": "Loket.WerknemerKpu.WijzeVanAanmaken"
},
"value": {
"type": "string",
"example": "Verloning",
"description": "The description of registrationmethod ('Wijze van aanmaken'). Possible values are \"Verloning\", \"Schatting\" and \"Handmatig\"",
"readOnly": true,
"x-loket-db-field": "dbo.ctWerknemerKpuWijzeVanAanmaak.Omschrijving"
}
}
}
}
},
"paymentinformationsepaYYYY-MM-DD": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"payrollComponent": {
"type": "object",
"format": "metaData",
"readOnly": false,
"description": "The payroll component for which the outgoing payment records applies.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 260,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerExcasso.ComponentID",
"x-loket-implementation1": "Bij het opvoeren/wijzigen van een component moet aan de achterkant ook het veld 'Soort' worden gevuld. De volgende logica; [component 260 = soort 1] , [component 479 = soort 3], [overige componenten = 4]",
"x-loket-implementation2": "Bij het opvoeren/wijzigen van een regel moet aan de achterkant het veld Excasso worden gevuld met numerieke 0 (heeft geen praktische betekenis meer)",
"x-loket-comment": "De waarde van soort is nodig omdat dit nog wordt gebruikt aan de achterkant van Loketje (de gebruiker zegt dit niks. De 'oude' validatie controleert ook op `Soort` maar gezien `Soort=2` niet meer kan voorkomen is het voldoende om te controleren op componentnummer"
},
"description": {
"type": "string",
"example": "NETTOLOON",
"minLength": 0,
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam"
}
}
},
"iban": {
"type": "string",
"example": "NL52ABNA0424968264",
"description": "International Bank Account Number (IBAN). Only IBAN without spaces are accepted.\n",
"minLength": 0,
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerExcasso.IBAN",
"x-loket-implementation": "Bij het opvoeren/ wijzigen van een IBAN moet ook het veld BankGiroRekeningNummer worden gevuld. Bij NL'se IBAN; vertaal naar een correcte giro-rekening. Bij niet NL'se IBAN zet altijd op 1.",
"x-loket-comment": "Het BankGiroRekeningNummer is nodig om dat deze waarde wordt gebruikt voor het berekenen van een controlegetal bij een betaalbestand."
},
"bic": {
"type": [
"string",
"null"
],
"example": "AUDFDE21",
"description": "BIC /SWIFT code. Only applicable for a non-Dutch IBAN\n",
"minLength": 0,
"maxLength": 11,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerExcasso.IBAN"
},
"visibleOnPayslip": {
"type": "boolean",
"example": true,
"description": "Indicates whether the payment-component is visible on a payslip.\n",
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerExcasso.AfdrukkenOpStrook",
"x-loket-implementation": "code 1 = true en code 2 = false (is nu een code tabel wordt boolean)"
},
"beneficiary": {
"type": "object",
"description": "Information regarding the beneficiary coresponding with the bank account number",
"properties": {
"name": {
"type": [
"string",
"null"
],
"example": "Ben Hur",
"description": "Name of beneficiary.\n",
"minLength": 1,
"maxLength": 70,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerExcasso.NaamBegunstigde"
},
"city": {
"type": [
"string",
"null"
],
"example": "Rome",
"description": "City name of beneficiary.\n",
"minLength": 1,
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerExcasso.PlaatsnaamBegunstigde"
}
}
},
"description1": {
"type": [
"string",
"null"
],
"example": "xx",
"description": "Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.\n",
"minLength": 1,
"maxLength": 32,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerExcasso.Omschrijving1",
"x-loket-comment": "Het opknippen van de omschrijving komt uit de tijd van ClieOp. SEPA plakt het gewoon aan elkaar. In de praktijk blijkt het huidige te volstaan (we doen bij deze geen aanpassingen in de functionaliteit/ database)."
},
"description2": {
"type": [
"string",
"null"
],
"example": "x",
"description": "Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.\n",
"minLength": 1,
"maxLength": 32,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerExcasso.Omschrijving2"
}
}
},
"paymentinformationsepaseparatepayments": {
"x-loket-comment": "Het veld Soort in de tabel (=WerknemerExcassoAfsplitsen) is ALTIJD 99 voor deze resource!!!",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "Start date of this record\n\n__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).\n",
"readOnly": false,
"x-loket-db-field": "WerknemerExcassoAfsplitsen.DatumIngang"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the record\n",
"readOnly": false,
"x-loket-db-field": "WerknemerExcassoAfsplitsen.DatumEinde"
},
"iban": {
"type": "string",
"example": "NL52ABNA0424968264",
"description": "International Bank Account Number (IBAN). Only IBAN without spaces are accepted.\n",
"minLength": 1,
"maxLength": 35,
"readOnly": false,
"x-loket-db-field": "WerknemerExcassoAfsplitsen.IBAN"
},
"amount": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 32,
"description": "The amount to be split from the net salary",
"minimum": 0.01,
"maximum": 99999999.99,
"readOnly": false,
"x-loket-db-field": "WerknemerExcassoAfsplitsen.Inhouding"
},
"nameBeneficiary": {
"type": "string",
"example": "Ben Hur",
"description": "Name of beneficiary\n",
"minLength": 1,
"maxLength": 70,
"readOnly": false,
"x-loket-db-field": "WerknemerExcassoAfsplitsen.NaamBegunstigde"
},
"cityBeneficiary": {
"type": [
"string",
"null"
],
"example": "Rome",
"description": "City name of beneficiary\n",
"minLength": 1,
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "WerknemerExcassoAfsplitsen.PlaatsnaamBegunstigde"
},
"description1": {
"type": "string",
"example": "Savings to different account",
"description": "Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.\n",
"minLength": 1,
"maxLength": 32,
"readOnly": false,
"x-loket-db-field": "WerknemerExcassoAfsplitsen.Omschrijving1",
"x-loket-comment": "Het opknippen van de omschrijving komt uit de tijd van ClieOp. SEPA plakt het gewoon aan elkaar. In de praktijk blijkt het huidige te volstaan (we doen bij deze geen aanpassingen in de functionaliteit/ database)."
},
"description2": {
"type": [
"string",
"null"
],
"example": "from net wage",
"description": "Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.\n",
"minLength": 1,
"maxLength": 32,
"readOnly": false,
"x-loket-db-field": "WerknemerExcassoAfsplitsen.Omschrijving2"
}
}
},
"attachmentOfEarnings": {
"x-loket-comment": "see https://loketnl.atlassian.net/wiki/spaces/WEBAPI/pages/1404010593/Resource+Attachment+of+earnings+loonbeslag",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "Start date of this record\n",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the record\n",
"readOnly": false
},
"descriptionPayslip": {
"type": "string",
"example": "payment to creditor x",
"description": "This value is shown on the payslip to identify the attachment.\n",
"minLength": 1,
"maxLength": 14,
"readOnly": false
},
"creditor": {
"type": "object",
"description": "Information regarding the creditor",
"properties": {
"type": {
"type": "object",
"format": "metadata",
"description": "The type of creditor. A preferent creditor has priority over non-preferent creditors.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Preferente schuldeiser",
"maxLength": 50,
"readOnly": true
}
}
},
"priority": {
"type": "integer",
"format": "int32",
"example": 0,
"minimum": 0,
"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.",
"readOnly": false
}
}
},
"totalAmount": {
"type": "object",
"properties": {
"owed": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 320,
"description": "The total amount to be paid to the creditor",
"minimum": 0.01,
"maximum": 99999999.99,
"readOnly": false
},
"paid": {
"type": "object",
"readOnly": true,
"properties": {
"inApprovedPayrollRuns": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 50,
"description": "The total amount registerd in payroll run(s) with the status \"approved\".",
"minimum": 0,
"maximum": 99999999.99,
"readOnly": true
},
"inOpenPayrollRun": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 0,
"description": "The total amount registerd in payroll run(s) with the status \"open\". \n\nNote that open payroll runs are not final until they get approved, changes are possible until then.",
"minimum": 0,
"maximum": 99999999.99,
"readOnly": true
}
}
}
}
},
"fixedPaymentPerPayrollPeriod": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 50,
"description": "Set a fixed sum to be payed every payroll period.\n\n__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.",
"minimum": 0.01,
"maximum": 99999999.99,
"readOnly": false,
"x-loket-comment": "null = 0"
},
"iban": {
"type": "string",
"example": "NL52ABNA0424968264",
"description": "International Bank Account Number (IBAN). Only IBAN without spaces are accepted.\n",
"minLength": 1,
"maxLength": 35,
"readOnly": false
},
"beneficiary": {
"type": "object",
"description": "Information regarding the beneficiary coresponding with the bank account number",
"properties": {
"name": {
"type": "string",
"example": "Ben Hur",
"description": "Name of the beneficiary\n",
"minLength": 1,
"maxLength": 70,
"readOnly": false
},
"city": {
"type": [
"string",
"null"
],
"example": "Rome",
"description": "City name of beneficiary\n",
"minLength": 1,
"maxLength": 24,
"readOnly": false
}
}
},
"description1": {
"type": "string",
"example": "Savings to different account",
"description": "Description 1. Both description field values will be a line in the (unstructured) description of the SEPA file.\n",
"minLength": 1,
"maxLength": 32,
"readOnly": false,
"x-loket-comment": "Het opknippen van de omschrijving komt uit de tijd van ClieOp. SEPA plakt het gewoon aan elkaar. In de praktijk blijkt het huidige te volstaan (we doen bij deze geen aanpassingen in de functionaliteit/ database)."
},
"description2": {
"type": [
"string",
"null"
],
"example": "from net wage",
"description": "Description 2. Both description field values will be a line in the (unstructured) description of the SEPA file.\n",
"minLength": 1,
"maxLength": 32,
"readOnly": false
}
}
},
"protectedearnings": {
"x-loket-comment": "see",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "Start date of this record\nA (broken chain)[./#section/Data/Date-chains] is maintained within this resource.\n\n__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).\n",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the record\n",
"readOnly": false
},
"threshold": {
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 50,
"description": "The total amount of net wage that is protected.",
"minimum": 0,
"maximum": 99999999.99,
"readOnly": false
}
}
},
"fiscal_1-1-2027": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"$ref": "#/components/schemas/startDate-5"
},
"endDate": {
"$ref": "#/components/schemas/endDate-6"
},
"annualSalary": {
"$ref": "#/components/schemas/annualSalary"
},
"deviatingTaxTableCode": {
"$ref": "#/components/schemas/deviatingTaxTableCode"
},
"deviatingPayrollTaxTableColour": {
"$ref": "#/components/schemas/deviatingPayrollTaxTableColour"
},
"applyDayTables": {
"$ref": "#/components/schemas/applyDayTables"
},
"deviatingPayrollTaxPercentage": {
"$ref": "#/components/schemas/deviatingPayrollTaxPercentage"
},
"applyDeviatingPayrollTaxPercentageOn": {
"$ref": "#/components/schemas/applyDeviatingPayrollTaxPercentageOn"
},
"applyPayrollTaxDeduction": {
"$ref": "#/components/schemas/applyPayrollTaxDeduction"
},
"applyStudentDeduction": {
"$ref": "#/components/schemas/applyStudentDeduction"
},
"residentOf": {
"$ref": "#/components/schemas/residentOf"
},
"applySalarysplit": {
"$ref": "#/components/schemas/applySalarysplit"
},
"percentageForeignIncome": {
"$ref": "#/components/schemas/percentageForeignIncome"
},
"deviatingCalculationRulePayrollTax": {
"$ref": "#/components/schemas/deviatingCalculationRulePayrollTax"
},
"doesWageIncludeAow": {
"$ref": "#/components/schemas/doesWageIncludeAow"
},
"doesWageIncludeWajong": {
"$ref": "#/components/schemas/doesWageIncludeWajong"
},
"hasEmployeeLoan": {
"$ref": "#/components/schemas/hasEmployeeLoan"
},
"usesTransportByWithholdingAgent": {
"$ref": "#/components/schemas/usesTransportByWithholdingAgent"
},
"deviatingSmallJobsArrangement": {
"$ref": "#/components/schemas/deviatingSmallJobsArrangement"
},
"contributionReductionEducation": {
"$ref": "#/components/schemas/contributionReductionEducation"
},
"specialIndication": {
"$ref": "#/components/schemas/specialIndication"
},
"applySingleElderlyTaxDeduction": {
"$ref": "#/components/schemas/applySingleElderlyTaxDeduction"
}
}
},
"calculatedAnnualSalary": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"annualSalary": {
"$ref": "#/components/schemas/annualSalary"
}
}
},
"fiscalPropertiesCollective": {
"properties": {
"employmentId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"startDate": {
"type": "string",
"format": "date",
"example": "1995-05-21",
"description": "The start date for the information in the record.\nA (linked chain)[./#section/Data/Date-chains] is maintained within this resource.\n",
"readOnly": false
},
"annualSalary": {
"$ref": "#/components/schemas/annualSalary"
}
}
},
"additionaltaxliability": {
"type": [
"object",
"null"
],
"properties": {
"licensePlateNumber": {
"type": "string",
"example": "GP586D",
"description": "Vehicle registration (license plate of the vehicle). The number should be provided with or without any hyphens (-).\n",
"minLength": 0,
"maxLength": 15,
"readOnly": false
},
"dateOfFirstAdmission": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "First day of admission for the vehicle (datum eerste toelating). ",
"readOnly": false
},
"valueForTaxPurposes": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,6})(.\\d{1,2})?$",
"example": 20000,
"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.\n",
"minimum": 0.01,
"maximum": 999999.99,
"readOnly": false,
"x-loket-implementation": "0 in db == NULL in API"
},
"additionalTaxLiabilityGroup": {
"type": [
"object",
"null"
],
"format": "metaData",
"description": "Indicates what additional tax liability percentage (bijtelling) should be used for calculating the tax liabiltiy in the payroll process.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerAuto.Bijtelling"
},
"value": {
"type": "string",
"example": "Standaard tarief (25% tot 2017)",
"minLength": 0,
"maxLength": 100,
"readOnly": true,
"x-loket-db-field": "dbo.ctBijtelling"
}
}
}
}
},
"startDate-7": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this fund starts.\n\nA (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.",
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.DatumIngang"
},
"endDate-8": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.DatumEinde"
},
"fund": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the fund\n",
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.Regeling",
"x-loket-implementation": "Dit is een ulsa overerving item dus een int als key"
},
"description": {
"type": "string",
"example": "Ouderdomspensioen",
"description": "The description of the fund\n",
"minLength": 1,
"maxLength": 255,
"readOnly": true,
"x-loket-db-field": "ulsa.Fonds.Omschrijving"
}
}
},
"deviations": {
"type": [
"object",
"null"
],
"readOnly": false,
"description": "Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`.\n\nDeviating is done on either all the fields or none.\n\n__Note:__ `deviations` and `fixedContribution` are mutually exclusive.",
"x-loket-implementation": "Als dit element aanwezig is mag `fixedContribution` geen waarde hebben (moet dus null zijn)",
"x-loket-implementation1": "Vulling/aanwezigheid van dit element is afhankelijk van \"[BerekeningSoort]\"(ctPensioenPremieBerekeningSoort). Indien [BerekeningSoort] = 1 dan element op null stellen. Indien [BerekeningSoort] = 2 het element opnemen en sub-elementen vullen (zie subelementen elementen hoe te vullen). Indien [BerekeningSoort] = 3 dan element op null stellen.",
"properties": {
"employmentContributionPercentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,4})?$",
"example": 11,
"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.\n\n__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).",
"minimum": 0,
"maximum": 100,
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.Premie"
},
"totalContributionPercentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,4})?$",
"example": 12.0007,
"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.\n\n__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).",
"minimum": 0,
"maximum": 100,
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.afdracht"
}
}
},
"fixedContribution": {
"type": [
"object",
"null"
],
"readOnly": false,
"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.\n\nSetting a fixed contribution is done on either all the fields or none.\n\n__Note:__ `deviations` and `fixedContribution` are mutually exclusive.",
"x-loket-implementation": "Als dit element aanwezig is mag `deviations` geen waarde hebben (moet dus null zijn)",
"x-loket-implementation1": "Vulling/aanwezigheid van dit element is afhankelijk van \"[Loket].[werknemerfonds].[BerekeningSoort]\"(ctPensioenPremieBerekeningSoort). Indien [BerekeningSoort] = 1 dan `fixedContribution` op null stellen. Indien [BerekeningSoort] = 2 dan `fixedContribution` op null stellen. Indien [BerekeningSoort] = 3 dan `fixedContribution` en sub-elementen vullen (zie subelementen elementen hoe te vullen).",
"properties": {
"employmentContribution": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 1789,
"description": "The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates.\n\n__Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0.00 up to 9999.99",
"minimum": 0,
"maximum": 99999999.99,
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.Premie"
},
"totalContribution": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 2569,
"description": "The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates.\n\n__Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0 up to 9999.99",
"minimum": 0,
"maximum": 99999999.99,
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.afdracht"
}
}
},
"vitalityScheme": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": false,
"x-loket-implementation": "0 = null",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the vitality scheme\n",
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.Vitaliteitsregeling",
"x-loket-implementation": "Dit is een ulsa overerving item dus een int als key"
},
"value": {
"type": "string",
"example": "Volgens regeling",
"description": "The description of the Vitaliteitsregeling\n",
"minLength": 1,
"maxLength": 255,
"readOnly": true,
"x-loket-db-field": "dbo.ctVitaliteitsRegelingWerkgever / dbo.ctVitaliteitsRegelingWerknemer"
}
}
},
"fundtotal2023-05-26": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"$ref": "#/components/schemas/startDate-7"
},
"endDate": {
"$ref": "#/components/schemas/endDate-8"
},
"fund": {
"$ref": "#/components/schemas/fund"
},
"deviations": {
"$ref": "#/components/schemas/deviations"
},
"fixedContribution": {
"$ref": "#/components/schemas/fixedContribution"
},
"vitalityScheme": {
"$ref": "#/components/schemas/vitalityScheme"
}
}
},
"fundTotal": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"$ref": "#/components/schemas/startDate-7"
},
"endDate": {
"$ref": "#/components/schemas/endDate-8"
},
"fund": {
"$ref": "#/components/schemas/fund"
},
"deviations": {
"$ref": "#/components/schemas/deviations"
},
"fixedContribution": {
"$ref": "#/components/schemas/fixedContribution"
}
}
},
"fundReadOnly": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the fund\n",
"readOnly": true,
"x-loket-db-field": "Loket.werknemerfonds.Regeling",
"x-loket-implementation": "Dit is een ulsa overerving item dus een int als key"
},
"description": {
"type": "string",
"example": "Ouderdomspensioen",
"description": "The description of the fund\n",
"minLength": 1,
"maxLength": 255,
"readOnly": true,
"x-loket-db-field": "ulsa.Fonds.Omschrijving"
}
}
},
"fundReadOnlyForPut2023-05-26": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"$ref": "#/components/schemas/startDate-7"
},
"endDate": {
"$ref": "#/components/schemas/endDate-8"
},
"fund": {
"$ref": "#/components/schemas/fundReadOnly"
},
"deviations": {
"$ref": "#/components/schemas/deviations"
},
"fixedContribution": {
"$ref": "#/components/schemas/fixedContribution"
},
"vitalityScheme": {
"$ref": "#/components/schemas/vitalityScheme"
}
}
},
"fundReadOnlyForPut": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"$ref": "#/components/schemas/startDate-7"
},
"endDate": {
"$ref": "#/components/schemas/endDate-8"
},
"fund": {
"$ref": "#/components/schemas/fundReadOnly"
},
"deviations": {
"$ref": "#/components/schemas/deviations"
},
"fixedContribution": {
"$ref": "#/components/schemas/fixedContribution"
}
}
},
"fundTotal-2": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this fund starts.\n\nA (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.",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false
},
"fund": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the fund\n",
"readOnly": false
},
"description": {
"type": "string",
"example": "Ouderdomspensioen",
"description": "The description of the fund\n",
"minLength": 1,
"maxLength": 255,
"readOnly": true
}
}
},
"deviations": {
"type": [
"object",
"null"
],
"readOnly": false,
"description": "Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`.\n\nDeviating is done on either all the fields or none.\n\n__Note:__ `deviations` and `fixedContribution` are mutually exclusive.",
"properties": {
"employmentContributionPercentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,3})?$",
"example": 11,
"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.\n\n__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).",
"minimum": 0,
"maximum": 100,
"readOnly": false
},
"totalContributionPercentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,3})?$",
"example": 12.007,
"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.\n\n__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).",
"minimum": 0,
"maximum": 100,
"readOnly": false
}
}
},
"fixedContribution": {
"type": [
"object",
"null"
],
"readOnly": false,
"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.\n\nSetting a fixed contribution is done on either all the fields or none.\n\n__Note:__ `deviations` and `fixedContribution` are mutually exclusive.",
"properties": {
"employmentContribution": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 1789,
"description": "The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates.\n\n__Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0.00 up to 9999.99",
"minimum": 0,
"maximum": 99999999.99,
"readOnly": false
},
"totalContribution": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 2569,
"description": "The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates.\n\n__Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0 up to 9999.99",
"minimum": 0,
"maximum": 99999999.99,
"readOnly": false
}
}
}
}
},
"fundReadOnlyForPut-2": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this fund starts.\n\nA (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.",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false
},
"fund": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the fund\n",
"readOnly": true
},
"description": {
"type": "string",
"example": "Ouderdomspensioen",
"description": "The description of the fund\n",
"minLength": 1,
"maxLength": 255,
"readOnly": true
}
}
},
"deviations": {
"type": [
"object",
"null"
],
"readOnly": false,
"description": "Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`.\n\nDeviating is done on either all the fields or none.\n\n__Note:__ `deviations` and `fixedContribution` are mutually exclusive.",
"properties": {
"employmentContributionPercentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,3})?$",
"example": 11,
"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.",
"minimum": 0,
"maximum": 100,
"readOnly": false
},
"totalContributionPercentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,3})?$",
"example": 12.007,
"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.",
"minimum": 0,
"maximum": 100,
"readOnly": false
}
}
},
"fixedContribution": {
"type": [
"object",
"null"
],
"readOnly": false,
"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.\n\nSetting a fixed contribution is done on either all the fields or none.\n\n__Note:__ `deviations` and `fixedContribution` are mutually exclusive.",
"properties": {
"employmentContribution": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 1789,
"description": "The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates.",
"minimum": 0,
"maximum": 99999999.99,
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.Premie"
},
"totalContribution": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 2569,
"description": "The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates.",
"minimum": 0,
"maximum": 99999999.99,
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.afdracht"
}
}
}
}
},
"employmentFundsCollectivePost": {
"properties": {
"employmentId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this fund starts.\n\nA (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.",
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.DatumIngang"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.DatumEinde"
},
"fund": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the fund\n",
"readOnly": false
}
}
},
"deviations": {
"type": [
"object",
"null"
],
"readOnly": false,
"description": "Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`.\n\nDeviating is done on either all the fields or none.\n\n__Note:__ `deviations` and `fixedContribution` are mutually exclusive.",
"x-loket-implementation": "Als dit element aanwezig is mag `fixedContribution` geen waarde hebben (moet dus null zijn)",
"x-loket-implementation1": "Vulling/aanwezigheid van dit element is afhankelijk van \"[BerekeningSoort]\"(ctPensioenPremieBerekeningSoort). Indien [BerekeningSoort] = 1 dan element op null stellen. Indien [BerekeningSoort] = 2 het element opnemen en sub-elementen vullen (zie subelementen elementen hoe te vullen). Indien [BerekeningSoort] = 3 dan element op null stellen.",
"properties": {
"employmentContributionPercentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,4})?$",
"example": 11,
"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.\n\n__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).",
"minimum": 0,
"maximum": 100,
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.Premie"
},
"totalContributionPercentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,4})?$",
"example": 12.0007,
"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.\n\n__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).",
"minimum": 0,
"maximum": 100,
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.afdracht"
}
}
},
"fixedContribution": {
"type": [
"object",
"null"
],
"readOnly": false,
"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.\n\nSetting a fixed contribution is done on either all the fields or none.\n\n__Note:__ `deviations` and `fixedContribution` are mutually exclusive.",
"x-loket-implementation": "Als dit element aanwezig is mag `deviations` geen waarde hebben (moet dus null zijn)",
"x-loket-implementation1": "Vulling/aanwezigheid van dit element is afhankelijk van \"[Loket].[werknemerfonds].[BerekeningSoort]\"(ctPensioenPremieBerekeningSoort). Indien [BerekeningSoort] = 1 dan `fixedContribution` op null stellen. Indien [BerekeningSoort] = 2 dan `fixedContribution` op null stellen. Indien [BerekeningSoort] = 3 dan `fixedContribution` en sub-elementen vullen (zie subelementen elementen hoe te vullen).",
"properties": {
"employmentContribution": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 1789,
"description": "The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates.\n\n__Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0.00 up to 9999.99",
"minimum": 0,
"maximum": 99999999.99,
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.Premie"
},
"totalContribution": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 2569,
"description": "The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates.\n\n__Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0 up to 9999.99",
"minimum": 0,
"maximum": 99999999.99,
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.afdracht"
}
}
}
}
},
"employmentFundsCollectivePatch": {
"properties": {
"employmentId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"endDate": {
"type": "string",
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.DatumEinde"
},
"employmentFundId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
}
}
},
"abpFundsCollectivePost": {
"properties": {
"employmentId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this fund starts.\n\nA (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.",
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.DatumIngang"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.DatumEinde"
},
"fund": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the fund\n",
"readOnly": false
}
}
},
"deviations": {
"type": [
"object",
"null"
],
"readOnly": false,
"description": "Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `fund`.\n\nDeviating is done on either all the fields or none.\n\n__Note:__ `deviations` and `fixedContribution` are mutually exclusive.",
"x-loket-implementation": "Als dit element aanwezig is mag `fixedContribution` geen waarde hebben (moet dus null zijn)",
"x-loket-implementation1": "Vulling/aanwezigheid van dit element is afhankelijk van \"[BerekeningSoort]\"(ctPensioenPremieBerekeningSoort). Indien [BerekeningSoort] = 1 dan element op null stellen. Indien [BerekeningSoort] = 2 het element opnemen en sub-elementen vullen (zie subelementen elementen hoe te vullen). Indien [BerekeningSoort] = 3 dan element op null stellen.",
"properties": {
"employmentContributionPercentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,4})?$",
"example": 11,
"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.\n\n__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).",
"minimum": 0,
"maximum": 100,
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.Premie"
},
"totalContributionPercentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,4})?$",
"example": 12.0007,
"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.\n\n__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).",
"minimum": 0,
"maximum": 100,
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.afdracht"
}
}
},
"fixedContribution": {
"type": [
"object",
"null"
],
"readOnly": false,
"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.\n\nSetting a fixed contribution is done on either all the fields or none.\n\n__Note:__ `deviations` and `fixedContribution` are mutually exclusive.",
"x-loket-implementation": "Als dit element aanwezig is mag `deviations` geen waarde hebben (moet dus null zijn)",
"x-loket-implementation1": "Vulling/aanwezigheid van dit element is afhankelijk van \"[Loket].[werknemerfonds].[BerekeningSoort]\"(ctPensioenPremieBerekeningSoort). Indien [BerekeningSoort] = 1 dan `fixedContribution` op null stellen. Indien [BerekeningSoort] = 2 dan `fixedContribution` op null stellen. Indien [BerekeningSoort] = 3 dan `fixedContribution` en sub-elementen vullen (zie subelementen elementen hoe te vullen).",
"properties": {
"employmentContribution": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 1789,
"description": "The employment contribution (in money) that the employee will pay instead of what the calculation of the `fund` indicates.\n\n__Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0.00 up to 9999.99",
"minimum": 0,
"maximum": 99999999.99,
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.Premie"
},
"totalContribution": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,8})(\\.\\d{1,2})?$",
"example": 2569,
"description": "The total contribution (in money) that the employer and employee pay instead of what the calculation of the `fund` indicates.\n\n__Note:__ Records with a `startDate` before 1-1-2014 have a different range, from 0 up to 9999.99",
"minimum": 0,
"maximum": 99999999.99,
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.afdracht"
}
}
}
}
},
"abpFundsCollectivePatch": {
"properties": {
"employmentId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"endDate": {
"type": "string",
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.DatumEinde"
},
"abpFundId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
}
}
},
"payrollComponentReadOnlyFalse": {
"type": "object",
"format": "metadata",
"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\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-implementation": "Dit veld is in de interface read only bij het wijzigen.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 545,
"description": "The number for the payroll component. \n",
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.ComponentID"
},
"description": {
"type": "string",
"example": "JAAR GRSL3",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)",
"x-loket-implementation": "Omdat hier met datums en niet met verloningsperiodes gewerkt wordt moet de beschrijving van het actieve jaar gebruikt worden."
}
}
},
"basesForEmploymentFundCalculationGetPost": {
"allOf": [
{
"$ref": "#/components/schemas/basesForEmploymentFundCalculationBaseObject"
},
{
"properties": {
"payrollComponent": {
"$ref": "#/components/schemas/payrollComponentReadOnlyFalse"
}
}
}
]
},
"basesForEmploymentFundCalculationPut": {
"allOf": [
{
"$ref": "#/components/schemas/basesForEmploymentFundCalculationBaseObject"
}
]
},
"basesForEmploymentFundCalculationCollectivePost": {
"properties": {
"employmentId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"startDate": {
"type": "string",
"format": "date",
"example": "2027-01-01",
"description": "The date on which this base for employment fund calculation starts.\n\nA (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",
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfondsgrondslag.DatumIngang"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2027-12-31",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfondsgrondslag.DatumEinde"
},
"payrollComponent": {
"type": "object",
"format": "metadata",
"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\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 101,
"description": "The number for the payroll component.\n",
"readOnly": false,
"x-loket-db-field": "Loket.werknemerfonds.ComponentID"
}
}
},
"base": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,6})(\\.\\d{1,2})?$",
"description": "The base (amount of money) to be used in the fund calculation\n",
"example": 6,
"minimum": 0.01,
"maximum": 999999.99,
"readOnly": false
}
}
},
"basesForCalculationPut": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this base starts.\n\nA (linked chain)[./#section/Data/Date-chains] per base is maintained within this resource.\nSo multiple bases can be active at the same time but one specific base can never be active multiple times at the same time.",
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking.DatumIngang"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking.DatumEinde"
},
"deviations": {
"type": [
"object",
"null"
],
"readOnly": false,
"description": "Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `base`. \nSet `deviations` to null if no deviations apply.\n\nDeviating is done on either all the fields or none.",
"x-loket-implementation": "Vulling/aanwezigheid van dit element is afhankelijk van \"[BerekeningSoort]\"(ctPensioenPremieBerekeningSoort). Indien [BerekeningSoort] = 1 dan element op null stellen. Indien [BerekeningSoort] = 2 het element opnemen en sub-elementen vullen (zie subelementen elementen hoe te vullen).",
"properties": {
"percentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,6})?$",
"example": 8,
"description": "Deviation from the percentage",
"minimum": 0,
"maximum": 999.999999,
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking.Percentage"
},
"reservationPercentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,6})?$",
"example": 12.0007,
"description": "deviation from the reservation percentage",
"minimum": 0,
"maximum": 999.999999,
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking.ReserveringsPercentage"
},
"financialReservationPercentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,6})?$",
"example": 10.000007,
"description": "deviation from the financial reservation percentage",
"minimum": 0,
"maximum": 999.999999,
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking.ReserveringsPercentageFinancieel"
}
}
},
"ageBasedMinimum": {
"type": "object",
"format": "metadata",
"description": "This fields indicates how the age based minimum is applied\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The number for the ageBasedMinimum\n",
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking"
},
"value": {
"type": "string",
"example": "Toepassen hoogste leeftijd",
"description": "The description of the ageBasedMinimum\n",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.ctGrondslagMinimumMaximum"
}
}
},
"ageBasedMaximum": {
"type": "object",
"format": "metadata",
"description": "This fields indicates how the age based maximum is applied\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The number for the ageBasedMaximum\n",
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking"
},
"value": {
"type": "string",
"example": "Toepassen hoogste leeftijd",
"description": "The description of the ageBasedMaximum\n",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.ctGrondslagMinimumMaximum"
}
}
}
}
},
"basesForCalculationCollectivePost": {
"properties": {
"employmentId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this base starts.\n\nA (linked chain)[./#section/Data/Date-chains] per base is maintained within this resource.\nSo multiple bases can be active at the same time but one specific base can never be active multiple times at the same time.",
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking.DatumIngang"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking.DatumEinde"
},
"deviations": {
"type": [
"object",
"null"
],
"readOnly": false,
"description": "Only set a value for the underlying fields if you want to deviate from the values as defined by the selected `base`. \nSet `deviations` to null if no deviations apply.\n\nDeviating is done on either all the fields or none.",
"x-loket-implementation": "Vulling/aanwezigheid van dit element is afhankelijk van \"[BerekeningSoort]\"(ctPensioenPremieBerekeningSoort). Indien [BerekeningSoort] = 1 dan element op null stellen. Indien [BerekeningSoort] = 2 het element opnemen en sub-elementen vullen (zie subelementen elementen hoe te vullen).",
"properties": {
"percentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,6})?$",
"example": 8,
"description": "Deviation from the percentage",
"minimum": 0,
"maximum": 999.999999,
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking.Percentage"
},
"reservationPercentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,6})?$",
"example": 12.0007,
"description": "deviation from the reservation percentage",
"minimum": 0,
"maximum": 999.999999,
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking.ReserveringsPercentage"
},
"financialReservationPercentage": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,6})?$",
"example": 10.000007,
"description": "deviation from the financial reservation percentage",
"minimum": 0,
"maximum": 999.999999,
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking.ReserveringsPercentageFinancieel"
}
}
},
"ageBasedMinimum": {
"type": "object",
"format": "metadata",
"description": "This fields indicates how the age based minimum is applied\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The number for the ageBasedMinimum\n",
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking"
},
"value": {
"type": "string",
"example": "Toepassen hoogste leeftijd",
"description": "The description of the ageBasedMinimum\n",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.ctGrondslagMinimumMaximum"
}
}
},
"ageBasedMaximum": {
"type": "object",
"format": "metadata",
"description": "This fields indicates how the age based maximum is applied\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The number for the ageBasedMaximum\n",
"readOnly": false,
"x-loket-db-field": "Loket.GrondslagSalarisverwerking"
},
"value": {
"type": "string",
"example": "Toepassen hoogste leeftijd",
"description": "The description of the ageBasedMaximum\n",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.ctGrondslagMinimumMaximum"
}
}
},
"base": {
"type": "object",
"format": "metadata",
"description": "`base` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-implementation": "Dit veld is in de interface read only bij het wijzigen.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 545,
"description": "The number for the base\n",
"readOnly": false,
"x-loket-db-field": "Loket..grondslagId"
},
"value": {
"type": "string",
"example": "VAKANTIE TOESLAG, periodieke opbouw",
"description": "The description of the base\n",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Ulsa.grondslag.omschrijving",
"x-loket-implementation": "Omdat hier met datums en niet met verloningsperiodes gewerkt wordt moet de beschrijving van het actieve jaar gebruikt worden."
}
}
}
}
},
"basesForCalculationCollectivePatch": {
"properties": {
"employmentId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"endDate": {
"type": "string",
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": false
},
"baseForCalculationId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
}
}
},
"payrollComponentReadOnly": {
"type": "object",
"format": "metadata",
"readOnly": true,
"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.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-implementation": "Dit veld is in de interface read only bij het wijzigen.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 70,
"description": "The number for the payroll component.\n",
"readOnly": false
},
"description": {
"type": "string",
"example": "LOON/SALARIS",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true
}
}
},
"deviatingHourlyWagesPayrollComponentReadonly": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"$ref": "#/components/schemas/startDate-6"
},
"endDate": {
"$ref": "#/components/schemas/endDate-7"
},
"payrollComponent": {
"$ref": "#/components/schemas/payrollComponentReadOnly"
},
"value": {
"$ref": "#/components/schemas/value"
}
}
},
"customNotifications": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"notificationDate": {
"type": "string",
"format": "date",
"example": "2021-01-01",
"description": "The date on which the first notification occurs.",
"readOnly": false
},
"expirationDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2021-01-23",
"description": "The date on which the Notification will expire.",
"readOnly": false
},
"notificationText": {
"type": "string",
"example": "Signal renew document",
"description": "The description of the signal",
"readOnly": false
},
"recurrencePattern": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Define a pattern for repeating the notification. This pattern is used to create Notifications after the initial notification as defined in the notificationDate.\n",
"properties": {
"recurrenceNumber": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The number of the recurrence pattern. An example recurrence pattern is: repeat every 2 weeks.\n",
"minimum": 1,
"maximum": 365,
"readOnly": false
},
"recurrencePeriod": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The period of the recurrence pattern An example recurrence pattern is: repeat every 2 weeks.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false
},
"value": {
"type": "string",
"example": "Weeks",
"maxLength": 50,
"readOnly": true
}
}
},
"numberOfRepetitionsAfterFirstNotification": {
"type": "integer",
"format": "int32",
"example": 4,
"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.\n",
"minimum": 1,
"maximum": 99,
"readOnly": false
}
}
}
}
},
"employmentCustomFieldPost": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"customField": {
"type": "object",
"format": "metadata",
"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).\n",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of the custom field as defined at the employer level",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
"readOnly": false
},
"description": {
"type": "string",
"example": "Shoe size",
"maxLength": 50,
"readOnly": true
}
}
},
"value": {
"type": "string",
"maxLength": 255,
"example": "41",
"description": "The value for the custom field for the employment",
"readOnly": false
}
}
},
"benefitPut": {
"type": "object",
"properties": {
"percentage": {
"type": "number",
"format": "double",
"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).\n",
"example": 35,
"minimum": 0,
"maximum": 100,
"pattern": "^(\\d{1,3})(\\.\\d{1,2})?$",
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerSocialeUitkering.LoonkostenUitkeringsPercentage"
}
}
},
"socialSecurityBenefitsPut": {
"allOf": [
{
"$ref": "#/components/schemas/socialSecurityBenefits"
},
{
"properties": {
"benefit": {
"$ref": "#/components/schemas/benefitPut"
}
}
}
]
},
"wachtgeld": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2021-06-01",
"description": "The date on which this wachtgeld record starts.\n\nA (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. ",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": true
},
"value": {
"type": [
"number",
"null"
],
"example": 50.87,
"description": "The value for the wachtgeld.\n",
"minimum": 0.01,
"maximum": 99999.99,
"pattern": "^(\\d{1,5})(\\.\\d{1,2})?$",
"readOnly": false
},
"valueAdditionalIncomeCivilService": {
"type": [
"number",
"null"
],
"example": 50.87,
"description": "The value of additional income civil service (Neveninkomsten ambtelijk).\n",
"minimum": 0.01,
"maximum": 99999.99,
"pattern": "^(\\d{1,5})(\\.\\d{1,2})?$",
"readOnly": false
},
"valueAdditionalIncomeNonCivilService": {
"type": [
"number",
"null"
],
"example": 50.87,
"description": "The value of additional income non civil service (Neveninkomsten niet ambtelijk).\n",
"minimum": 0.01,
"maximum": 99999.99,
"pattern": "^(\\d{1,5})(\\.\\d{1,2})?$",
"readOnly": false
}
}
},
"contacts": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"contacts": {
"$ref": "#/components/schemas/employeeContact"
}
}
}
]
},
"children": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"child": {
"$ref": "#/components/schemas/child"
}
}
}
]
},
"citizenServiceNumber-3": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"citizenServiceNumber": {
"$ref": "#/components/schemas/citizenServiceNumber-2"
}
}
}
]
},
"employeeCustomFields": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"employeeCustomFields": {
"$ref": "#/components/schemas/employeeCustomField"
}
}
}
]
},
"actualPartners": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"partner": {
"$ref": "#/components/schemas/partner"
}
}
}
]
},
"employmentCustomFields": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"employmentCustomFields": {
"$ref": "#/components/schemas/employmentCustomField"
}
}
}
]
},
"paymentInformationSepa": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"paymentInformationSepa": {
"$ref": "#/components/schemas/paymentinformationsepa2018-01-01"
}
}
}
]
},
"organizationalEntities": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"organizationalEntity": {
"$ref": "#/components/schemas/organizationalEntity-2"
}
}
}
]
},
"wages": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"wage": {
"$ref": "#/components/schemas/wage-2"
}
}
}
]
},
"workingHours-3": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"workingHours": {
"$ref": "#/components/schemas/workinghours"
}
}
}
]
},
"benefitsAndDeductions": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"benefitsAndDeductions": {
"$ref": "#/components/schemas/benefitsAndDeductionsGetAndPut2018-01-01"
}
}
}
]
},
"employmentFunds-2": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"employmentFund": {
"$ref": "#/components/schemas/fundTotal"
}
}
}
]
},
"abpFunds-2": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"abpFund": {
"$ref": "#/components/schemas/fundTotal-2"
}
}
}
]
},
"fiscalProperties_1-1-2027": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"fiscalProperties": {
"$ref": "#/components/schemas/fiscal_1-1-2027"
}
}
}
]
},
"fiscalProperties": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"fiscalProperties": {
"$ref": "#/components/schemas/fiscal-2"
}
}
}
]
},
"extraterritorialCostReimbursementSchemes": {
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"extraterritorialCostReimbursementSchemes": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The start date of the entity.\n\nA (linked chain)[./#section/Data/Date-chains] is maintained within this resource.",
"readOnly": false
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The end date of the entity. The date is up to and including.",
"readOnly": true
},
"thirtyPercentFacility": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "If the employee comes to work in the Netherlands from another country, the employer may grant an untaxed reimbursement. (30%-regeling).",
"x-loket-comment": "https://www.belastingdienst.nl/wps/wcm/connect/bldcontenten/belastingdienst/individuals/living_and_working/working_in_another_country_temporarily/you_are_coming_to_work_in_the_netherlands/30_facility_for_incoming_employees/",
"x-loket-comment2": "0 = NULL",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.BijzondereKostenVergoeding"
},
"value": {
"type": "string",
"example": "Netto",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBijzondereKostenVergoeding"
}
}
},
"deviatingPercentageThirtyPercentFacility": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,6})?$",
"minimum": 0.000001,
"maximum": 29.999999,
"example": 20.2345,
"description": "Indicates a deviating percentage which should be applied for the 30% facility (30%-regeling)",
"readOnly": false,
"x-loket-db-field": "Loket.Fiscaal.AfwijkendBijzondereKostenVergoedingPercentage"
}
}
}
}
},
"healthCareInsuranceActConfigurations": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"healthCareInsuranceActConfiguration": {
"$ref": "#/components/schemas/healthcareInsuranceActConfiguration"
}
}
}
]
},
"socialSecurityConfigurations": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"socialSecurityConfiguration": {
"$ref": "#/components/schemas/socialSecurity-2"
}
}
}
]
},
"socialSecurityBenefits-2": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"socialSecurityBenefits": {
"$ref": "#/components/schemas/socialSecurityBenefitsPostGet"
}
}
}
]
},
"deviatingAwfContribution": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"deviatingAwfContribution": {
"$ref": "#/components/schemas/deviatingAwfcontributions"
}
}
}
]
},
"benefitsInKind": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"benefitsInKind": {
"$ref": "#/components/schemas/benefitInKind"
}
}
}
]
},
"companyCars": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"companyCars": {
"$ref": "#/components/schemas/companyCar"
}
}
}
]
},
"fiscalCompanyCars": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"fiscalCompanyCars": {
"$ref": "#/components/schemas/fiscalCompanyCar"
}
}
}
]
},
"journalAllocations": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"journalAllocations": {
"$ref": "#/components/schemas/journalAllocationObject"
}
}
}
]
},
"basesForCalculation": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"basesForCalculation": {
"$ref": "#/components/schemas/basesForCalculationGetPost"
}
}
}
]
},
"otherPayrollVariables-4": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"otherPayrollVariables": {
"$ref": "#/components/schemas/otherPayrollVariables-2"
}
}
}
]
},
"paymentInformationNonSepa-2": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"paymentInformationNonSepa": {
"$ref": "#/components/schemas/paymentInformationNonSepa"
}
}
}
]
},
"basesForEmploymentFundCalculation": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"basesForEmploymentFundCalculation": {
"$ref": "#/components/schemas/basesForEmploymentFundCalculationBaseObject"
}
}
}
]
},
"pensionBenefits-2": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"pensionBenefits": {
"$ref": "#/components/schemas/pensionBenefits"
}
}
}
]
},
"deviatingHourlyWage": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"deviatingHourlyWage": {
"$ref": "#/components/schemas/deviatingHourlyWages"
}
}
}
]
},
"costperhour": {
"allOf": [
{
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"costperhour": {
"$ref": "#/components/schemas/costPerHour"
}
}
}
]
},
"insuranceContract": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"belongsToEmployerId": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (a GUID/UUID) for the employer to which the Achmea isurance contract belongs. This id can be used for acquiring the list of employees for the employer.\n",
"readOnly": true,
"x-loket-db-field": "Loket.Werkgever.ExternId"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-05-21",
"description": "The date at which the Achmea isurance contract starts.",
"readOnly": true,
"x-loket-implementation": "Allen polissen worden teruggegeven. In de tabel staan zowel polissen als offertes. Geef alleen de records terug waarbij DatumIngangPolis gevuld is.",
"x-loket-db-field": "Loket.VerzuimverzekeringAchmea.DatumIngangPolis"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2025-05-21",
"description": "The date at which the Achmea isurance contract ends.",
"readOnly": false,
"x-loket-implementation": "Hier moet nog naar gekeken worden afhankelijk van het antwoord van achmea moeten polissen met een einddatum in het verleden niet worden teruggegeven. Voor nu nog geen logica op dit veld.",
"x-loket-db-field": "Loket.VerzuimverzekeringAchmea.DatumEindePolis"
},
"contractNumber": {
"type": "string",
"example": "0015697843",
"description": "The contract number (Dutch: polisnummer) for the Achmea insurance contract.",
"readOnly": true,
"maxLength": 20,
"x-loket-db-field": "Loket.VerzuimverzekeringAchmea.Polisnummer"
}
}
},
"wagePercentages": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-21",
"description": "The first day on which the percentages apply to the wages of all employees included in the Achmea insurance contract.",
"readOnly": false,
"x-loket-db-field": "Loket.VerzuimVerzekeringPercentages.DatumIngang"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.VerzuimVerzekeringPercentages.DatumEinde"
},
"yearEndPercentage": {
"type": [
"number",
"null"
],
"format": "double",
"example": 15,
"description": "The percentage of the gross wage used to determine the year-end bonus.",
"readOnly": false,
"x-loket-db-field": "Loket.VerzuimVerzekeringPercentages.PercentageEindejaarsuitkering"
},
"holidayAllowancePercentage": {
"type": [
"number",
"null"
],
"format": "double",
"example": 8,
"description": "The percentage of the gross wage used to determine the holiday allowance.",
"readOnly": false,
"x-loket-db-field": "Loket.VerzuimVerzekeringPercentages.PercentageVakantieToeslag"
}
}
},
"benifyObject": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "url",
"example": "https://www.benify.nl",
"description": "The URL to access the Benify portal",
"readOnly": true
}
}
},
"yourcampusObject": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "url",
"example": "https://www.yourcampus.nl",
"description": "The URL to access the Benify portal",
"readOnly": true
},
"validUntilDate": {
"type": "string",
"format": "date-time",
"example": "2022-05-08T15:16:49+02:00",
"description": "The time at which the validity of the url ends",
"readOnly": true
}
}
},
"qwoaterObject": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"providerId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of a provider (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"lastModifiedVersionNumber": {
"type": "integer",
"format": "int64",
"example": 70429274999853,
"description": "The version number reflects the latest version of all predefined underlying tables of this employer.",
"readOnly": true
}
}
},
"leavePolicy": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"description": "The name of the leave policy",
"example": "Normal leave",
"minLength": 1,
"maxLength": 50,
"readOnly": false
},
"leaveUnitType": {
"type": "object",
"format": "metadata",
"description": "Indicates what the unit type (hours or days) is. Employments linked to this leave policy use this leaveUnitType for their leave.",
"readOnly": false,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the unit type\n",
"readOnly": false
},
"value": {
"type": "string",
"example": "Uren",
"description": "The description for the leave unit type\n",
"readOnly": true
}
}
},
"roundTo": {
"type": "object",
"format": "metadata",
"description": "Indicates to how many digits after the decimal point to round the numbers",
"readOnly": false,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the roundTo\n",
"readOnly": false
},
"value": {
"type": "string",
"example": "0.01",
"description": "The description for the roundTo\n",
"readOnly": true
}
}
},
"roundingMethod": {
"type": "object",
"format": "metadata",
"description": "Indicates how to round the numbers ",
"readOnly": false,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the roundingMethod\n",
"readOnly": false
},
"value": {
"type": "string",
"example": "Logical",
"description": "The description for the roundingMethod\n",
"readOnly": true
}
}
},
"accrualType": {
"type": "object",
"format": "metadata",
"description": "Indicates how leave is accrued (yearly, monthly or hourly) ",
"readOnly": false,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the `accrualType`\n",
"readOnly": false
},
"value": {
"type": "string",
"example": "Jaar",
"description": "The description for the `accrualType`\n",
"readOnly": true
}
}
},
"dayOfTheMonthToPerformAutomaticLeaveCalculationOn": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 12,
"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.\nIf 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. ",
"minimum": 1,
"maximum": 31,
"readOnly": false
},
"payoutLeaveImmediately": {
"type": "boolean",
"example": false,
"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.",
"readOnly": false
},
"leaveEntitlement": {
"type": [
"object",
"null"
],
"readOnly": false,
"properties": {
"statutory": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,3})(.\\d{1,2})?$",
"example": 160,
"minimum": 0.01,
"maximum": 999.99,
"description": "The statutory leave (wetelijk verlof) linked employments are entitled to for a full time contract.",
"readOnly": false
},
"excessLeaveToStatutory": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,3})(.\\d{1,2})?$",
"example": 40,
"minimum": 0.01,
"maximum": 999.99,
"description": "The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.",
"readOnly": false
},
"wtr": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,3})(.\\d{1,2})?$",
"example": 40,
"minimum": 0.01,
"maximum": 999.99,
"description": "The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.",
"readOnly": false
}
}
},
"leaveRequest": {
"type": "object",
"readOnly": false,
"properties": {
"applyLeaveSchedule": {
"type": "boolean",
"example": false,
"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",
"readOnly": false
},
"useHolidaysInCalculation": {
"type": "boolean",
"example": false,
"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.\"\n\neg. 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",
"readOnly": false
},
"leavePattern": {
"type": [
"object",
"null"
],
"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.
Please note that the `leavePattern` should be left NULL if no data is present (as opposed to filling all fields with 0)
Each field represent the number of hours the employee normally works on that day.\n",
"properties": {
"oddWeeks": {
"type": "object",
"properties": {
"monday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenMaandag"
},
"tuesday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenDinsdag"
},
"wednesday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 4,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenWoensdag"
},
"thursday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 7.5,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenDonderdag"
},
"friday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 4,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenVrijdag"
},
"saturday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenZaterdag"
},
"sunday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenOnevenZondag"
}
}
},
"evenWeeks": {
"type": "object",
"properties": {
"monday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenMaandag"
},
"tuesday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenDinsdag"
},
"wednesday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenWoensdag"
},
"thursday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 8,
"minimum": 0,
"maximum": 24,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenDonderdag"
},
"friday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 2,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenVrijdag"
},
"saturday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenZaterdag"
},
"sunday": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 0,
"minimum": 0,
"maximum": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerktijdRooster.UrenEvenZondag"
}
}
}
}
}
}
},
"additionalLeave": {
"type": "object",
"readOnly": false,
"properties": {
"allocationType": {
"type": "object",
"format": "metadata",
"description": "Indicates how additional leave is to be assigned to the employments (linked to this leave policy).",
"readOnly": false,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the `additionalLeaveAllocationType`\n",
"readOnly": false
},
"value": {
"type": "string",
"example": "Boek alleen hoogste waarde",
"description": "The description for the `additionalLeaveAllocationType`\n",
"readOnly": true
}
}
},
"referenceDate1": {
"type": "object",
"description": "If `referenceDate2` has a value only the last 6 months of the year are allowed as values",
"properties": {
"month": {
"type": "object",
"format": "metadata",
"description": "The month of the first reference date ",
"readOnly": false,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the `referenceMonth`\n",
"readOnly": false
},
"value": {
"type": "string",
"example": "Januari",
"description": "The description for the `referenceMonth`\n",
"readOnly": true
}
}
},
"day": {
"type": "integer",
"format": "int32",
"example": 40,
"minimum": 1,
"maximum": 31,
"description": "The day of the first reference date.",
"readOnly": false
}
}
},
"referenceDate2": {
"type": [
"object",
"null"
],
"description": "Only use if applicable",
"properties": {
"month": {
"type": "object",
"format": "metadata",
"description": "The month of the second reference date ",
"readOnly": false,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the `referenceMonth`\n",
"readOnly": false
},
"value": {
"type": "string",
"example": "Januari",
"description": "The description for the `referenceMonth`\n",
"readOnly": true
}
}
},
"day": {
"type": "integer",
"format": "int32",
"example": 40,
"minimum": 1,
"maximum": 31,
"description": "The day of the second reference date.",
"readOnly": false
}
}
}
}
}
}
},
"copyLeavePolicy": {
"properties": {
"sourceLeavePolicyId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of the Leave policy at providerlevel which should be copied.",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"name": {
"type": [
"string",
"null"
],
"description": "The name of the leave policy",
"example": "Verlofregeling Metaal CAO",
"minLength": 1,
"maxLength": 50,
"readOnly": false
}
}
},
"leavePolicyIdOnly": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
},
"ageBasedLeave": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"from": {
"type": "object",
"readOnly": false,
"properties": {
"numberOfYears": {
"type": "integer",
"format": "int32",
"example": 40,
"minimum": 0,
"maximum": 999,
"description": "the employee's minimal age to be applicable for the additional leave",
"readOnly": false
},
"numberOfMonths": {
"type": "integer",
"format": "int32",
"example": 0,
"minimum": 0,
"maximum": 11,
"description": "the number of months of age to be applicable for the additional leave",
"readOnly": false
}
}
},
"upToAndIncluding": {
"type": "object",
"properties": {
"numberOfYears": {
"type": "integer",
"format": "int32",
"example": 50,
"minimum": 0,
"maximum": 999,
"description": "the employee's minimal age to be applicable for the additional leave",
"readOnly": false
},
"numberOfMonths": {
"type": "integer",
"format": "int32",
"example": 11,
"minimum": 0,
"maximum": 11,
"description": "the number of months of age to be applicable for the additional leave",
"readOnly": false
}
}
},
"leaveEntitlement": {
"type": "object",
"readOnly": false,
"properties": {
"excessLeaveToStatutory": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,3})(.\\d{1,2})?$",
"example": 40,
"minimum": 0.01,
"maximum": 999.99,
"description": "The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.\n\nEither excessLeaveToStatutory or wtr must have a value",
"readOnly": false
},
"wtr": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,3})(.\\d{1,2})?$",
"example": 40,
"minimum": 0.01,
"maximum": 999.99,
"description": "The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.\n \n\nEither excessLeaveToStatutory or wtr must have a value ",
"readOnly": false
}
}
}
}
},
"yearsOfServiceBasedLeave": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"from": {
"type": "object",
"properties": {
"numberOfYears": {
"type": "integer",
"format": "int32",
"example": 40,
"minimum": 0,
"maximum": 999,
"description": "the number of years of service to be applicable for the additional leave",
"readOnly": false
},
"numberOfMonths": {
"type": "integer",
"format": "int32",
"example": 0,
"minimum": 0,
"maximum": 11,
"description": "the number of months of service to be applicable for the additional leave",
"readOnly": false
}
}
},
"upToAndIncluding": {
"type": "object",
"properties": {
"numberOfYears": {
"type": "integer",
"format": "int32",
"example": 40,
"minimum": 0,
"maximum": 999,
"description": "the number of years of service to be applicable for the additional leave",
"readOnly": false
},
"numberOfMonths": {
"type": "integer",
"format": "int32",
"example": 0,
"minimum": 0,
"maximum": 11,
"description": "the number of months of service to be applicable for the additional leave",
"readOnly": false
}
}
},
"leaveEntitlement": {
"type": "object",
"readOnly": false,
"properties": {
"excessLeaveToStatutory": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,3})(.\\d{1,2})?$",
"example": 40,
"minimum": 0.01,
"maximum": 999.99,
"description": "The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.\n\nEither excessLeaveToStatutory or wtr must have a value",
"readOnly": false
},
"wtr": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,3})(.\\d{1,2})?$",
"example": 40,
"minimum": 0.01,
"maximum": 999.99,
"description": "The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.\n\nEither excessLeaveToStatutory or wtr must have a value",
"readOnly": false
}
}
}
}
},
"wageBasedLeave": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"fromWage": {
"type": "number",
"format": "double",
"example": 40,
"minimum": 0,
"maximum": 99999999999999.98,
"description": "the from wage the employment has to earn to be applicable for the additional leave",
"readOnly": false
},
"upToAndIncludingWage": {
"type": "number",
"format": "double",
"example": 40,
"minimum": 0,
"maximum": 99999999999999.98,
"description": "the up to and including wage the employment has to earn to be applicable for the additional leave",
"readOnly": false
},
"leaveEntitlement": {
"type": "object",
"readOnly": false,
"properties": {
"excessLeaveToStatutory": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,14})(.\\d{1,2})?$",
"example": 40,
"minimum": 0.01,
"maximum": 999.99,
"description": "The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract.\n \n\nEither excessLeaveToStatutory or wtr must have a value",
"readOnly": false
},
"wtr": {
"type": [
"number",
"null"
],
"format": "double",
"pattern": "^(\\d{1,3})(.\\d{1,2})?$",
"example": 40,
"minimum": 0.01,
"maximum": 999.99,
"description": "The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract.\n \n\nEither excessLeaveToStatutory or wtr must have a value",
"readOnly": false
}
}
}
}
},
"linkedEmployment-2": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"startDate": {
"type": "string",
"format": "date",
"example": "2020-01-01",
"description": "The date on which this employment starts.",
"readOnly": true
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2021-12-31",
"description": "The date on which this employment ends.",
"readOnly": true
},
"incomeRelationshipNumber": {
"type": "integer",
"format": "int32",
"example": 1,
"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.",
"minimum": 0,
"maximum": 9999,
"readOnly": true
},
"employee": {
"$ref": "#/components/schemas/employeeBasic",
"x-loket-comment": "dit betreft het read-only employee basic object dat ook op andere plekken (zoals Employment resource) wordt toegepast"
}
}
},
"linkedEmploymentsPatch": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (GUID/UUID) of the employment",
"readOnly": false
},
"action": {
"type": "string",
"enum": [
"link",
"unlink"
],
"description": "The action to perform.",
"readOnly": false
}
},
"required": [
"id",
"action"
]
},
"leavePolicyAccrual": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"leavePolicyAccrual": {
"type": "array",
"items": {
"type": "object",
"properties": {
"leaveType": {
"type": "object",
"format": "metadata",
"description": "The type of leave requested by the employee\n`leaveType` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the leave type.\n",
"readOnly": true,
"x-loket-db-field": "Loket.Verlof.Soort"
},
"value": {
"type": "string",
"example": "Verlof (bovenwettelijk)",
"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.\n",
"readOnly": true,
"x-loket-db-field": "Loket.vwVerlofSoortenMetAfwijkingen.Omschrijving"
}
}
},
"accrual": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 30,
"description": "The amount of leave units accrued for the leave type in the year\n",
"readOnly": true
},
"accrualAgeBasedLeave": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 30,
"description": "The amount of leave units accrued for the leave type in the year\n",
"readOnly": true
},
"accrualWageBasedLeave": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 30,
"description": "The amount of leave units accrued for the leave type in the year\n",
"readOnly": true
},
"accrualYearsOfServiceBasedLeave": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 30,
"description": "The amount of leave units accrued for the leave type in the year\n",
"readOnly": true
}
}
}
}
}
},
"accrualMultiGetObject": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"leavePolicyAccrual": {
"type": "array",
"items": {
"type": "object",
"properties": {
"leaveType": {
"type": "object",
"format": "metadata",
"description": "The type of leave requested by the employee\n`leaveType` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the leave type.\n",
"readOnly": true,
"x-loket-db-field": "Loket.Verlof.Soort"
},
"value": {
"type": "string",
"example": "Verlof (bovenwettelijk)",
"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.\n",
"readOnly": true,
"x-loket-db-field": "Loket.vwVerlofSoortenMetAfwijkingen.Omschrijving"
}
}
},
"accrual": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 30,
"description": "The amount of leave units accrued for the leave type in the year\n",
"readOnly": true
},
"accrualAgeBasedLeave": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 30,
"description": "The amount of leave units accrued for the leave type in the year\n",
"readOnly": true
},
"accrualWageBasedLeave": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 30,
"description": "The amount of leave units accrued for the leave type in the year\n",
"readOnly": true
},
"accrualYearsOfServiceBasedLeave": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 30,
"description": "The amount of leave units accrued for the leave type in the year\n",
"readOnly": true
}
}
}
}
}
},
"entitlementMultiGetObject": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"leavePolicyEntitlement": {
"type": "array",
"items": {
"type": "object",
"properties": {
"leaveType": {
"type": "object",
"format": "metadata",
"description": "The type of leave requested by the employee\n`leaveType` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the leave type.\n",
"readOnly": true,
"x-loket-db-field": "Loket.Verlof.Soort"
},
"value": {
"type": "string",
"example": "Verlof (bovenwettelijk)",
"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.\n",
"readOnly": true,
"x-loket-db-field": "Loket.vwVerlofSoortenMetAfwijkingen.Omschrijving"
}
}
},
"entitlement": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 30,
"description": "The amount of leave units accrued for the leave type in the year\n",
"readOnly": true
},
"entitlementAgeBasedLeave": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 30,
"description": "The amount of leave units accrued for the leave type in the year\n",
"readOnly": true
},
"entitlementWageBasedLeave": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 30,
"description": "The amount of leave units accrued for the leave type in the year\n",
"readOnly": true
},
"entitlementYearsOfServiceBasedLeave": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 30,
"description": "The amount of leave units accrued for the leave type in the year\n",
"readOnly": true
}
}
}
}
}
},
"entitlementMultiPatchObject": {
"properties": {
"employmentId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"leavePolicyId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"year": {
"type": "integer",
"example": 2023,
"description": "The year\n",
"readOnly": false
},
"month": {
"type": [
"integer",
"null"
],
"example": 12,
"description": "The year\n",
"readOnly": false
},
"includeStatutoryLeave": {
"type": "boolean",
"example": true,
"description": "Set to true to calculate and apply statutory leave\n",
"readOnly": false
},
"includeWtrLeave": {
"type": "boolean",
"example": true,
"description": "Set to true to calculate and apply wtr leave\n",
"readOnly": false
}
}
},
"entitlementSinglePatchObject": {
"properties": {
"leavePolicyId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"year": {
"type": "integer",
"example": 2023,
"description": "The year\n",
"readOnly": false
},
"month": {
"type": [
"integer",
"null"
],
"example": 12,
"description": "The year\n",
"readOnly": false
},
"includeStatutoryLeave": {
"type": "boolean",
"example": true,
"description": "Set to true to calculate and apply statutory leave\n",
"readOnly": false
},
"includeWtrLeave": {
"type": "boolean",
"example": true,
"description": "Set to true to calculate and apply wtr leave\n",
"readOnly": false
}
}
},
"leaveType-2": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"leaveType": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "The default configuration of the leave type\n\nIf the deviations object is set those values overwrite all the default values.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the leave type. This value is used in the `leaveType` metadata object to refer to this configuration (and the possible deviations)\n",
"readOnly": true
},
"value": {
"type": "string",
"example": "Verlof (bovenwettelijk)",
"maxLength": 50,
"description": "The description for the leave type.\n",
"readOnly": true
},
"balanceExceedsYear": {
"type": "boolean",
"example": true,
"description": "Indicates whether the balance at the end of the year for this leave type carries over to the next year.\n",
"readOnly": true
},
"enabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the leave type can be used in leave requests or leave records. \nThis influences only new records. Old records using this leave type will remain and show the corresponding information.\n",
"readOnly": true
},
"employeeCanRequestIncrease": {
"type": "boolean",
"example": true,
"description": "Indicates whether an employee can request an increase of leave via a leave request.\n",
"readOnly": true
}
}
},
"deviations": {
"type": [
"object",
"null"
],
"readOnly": false,
"description": "Optional deviations to the leave type.\n\nIf set these deviations will overwrite the default values.\n\nNote: Two leaveTypes are excluded from deviations \"verlof\" and \"Verlof bovenwettelijk\"",
"properties": {
"value": {
"type": "string",
"example": "Verlof",
"description": "The description for the leave type.\n",
"maxLength": 50,
"readOnly": false
},
"balanceExceedsYear": {
"type": "boolean",
"example": true,
"description": "Indicates whether the balance at the end of the year for this leave type carries over to the next year.\n",
"readOnly": false
},
"enabled": {
"type": "boolean",
"example": true,
"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.\n",
"readOnly": false
},
"employeeCanRequestIncrease": {
"type": "boolean",
"example": false,
"description": "Indicates whether an employee can request an increase of leave via a leave request.\n",
"readOnly": false
}
}
}
}
},
"leaveRequestPatch": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (a GUID/UUID)",
"readOnly": false
},
"action": {
"type": "string",
"enum": [
"accept",
"reject",
"reopen",
"revoke"
],
"description": "The action to perform on the leave request resulting in a change of `leaveRequestStatus`\nThe following transitions are possible per status\n* leaveRequestStatus = (1)submitted -> accept, reject or revoke(by employee)\n* leaveRequestStatus = (9)accepted -> revoke or reopen(by employee)\n* leaveRequestStatus = (3)rejected -> submitted\n* leaveRequestStatus = (10) accepted with revoke request -> accept of reject",
"readOnly": false
}
},
"required": [
"id",
"action"
]
},
"currentlyAvailableUnitsLeaveRequest": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"currentlyAvailableUnits": {
"$ref": "#/components/schemas/currentlyAvailableUnits"
}
}
},
"leave": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"numberOfUnits": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,3})(\\.\\d{1,2})?$",
"example": 8,
"description": "The number of leave units requested",
"minimum": 0,
"maximum": 999.99,
"readOnly": false,
"x-loket-db-field": "Loket.Verlof.AantalEenheden"
},
"unitType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "If known indicates what the unit type (hours or days) is for `numberOfUnits`. Otherwise the field will be null.",
"readOnly": true,
"x-loket-implementation": "Een \"gecalculeerd\" veld (LOK-3745) * Voor een dienstverband met 1 of meerdere gekoppelde verlofregelingen met allemaal dezelfde verlofeenheid, wordt die verlofeenheid getoond in de applicatie * Voor een dienstverband met meerdere gekoppelde verlofregelingen met _verschillende_ verlofeenheden (een vreemde inrichting), wordt er _geen_ verlofeenheid getoond in de applicatie * Voor een dienstverband _zonder_ gekoppelde verlofregelingen, wordt er _geen_ verlofeenheid getoond in de applicatie",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the unit type\n",
"readOnly": false,
"x-loket-db-field": "dbo.ctVerlofEenheid.code (op basis van de logica voor het hele object)"
},
"value": {
"type": "string",
"example": "Uren",
"description": "The description for the unit type\n",
"readOnly": true,
"x-loket-db-field": "dbo.ctVerlofEenheid.code"
}
}
},
"isAccrual": {
"type": "boolean",
"example": false,
"description": "Indicates whether the request is for accrual of leave.\n- false will result in a reduction of the employee's leave entitlement\n- true will result in an increase of the employee's leave entitlement\n",
"readOnly": false,
"x-loket-db-field": "Loket.Verlof.Factor",
"x-loket-implementation": "In de database is dit een integer veld met de waarde 1 of -1. In de API geven we true terug in het geval van waarde 1 en geven we false terug in het geval van waarde -1."
},
"startDate": {
"type": "string",
"format": "date",
"example": "2017-11-01",
"description": "The start date of the leave requested",
"readOnly": false,
"x-loket-db-field": "Loket.Verlof.DatumIngang"
},
"endDate": {
"type": "string",
"format": "date",
"example": "2017-11-01",
"description": "The end date of the leave requested (last day of the leave)",
"readOnly": false,
"x-loket-db-field": "Loket.Verlof.DatumEinde"
},
"leaveType": {
"type": "object",
"format": "metadata",
"description": "The type of leave requested by the employee\n`leaveType` is a metadata field within the employer context. Possible values can be managed by the user.",
"x-loket-implementation": "Hier zit wat logica achter om er voor te zorgen dat de situatie goed gaat als er geboekt is op een soort die later is uitgezet (tonen = nee)",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the leave type.\n",
"readOnly": false,
"x-loket-db-field": "Loket.Verlof.Soort"
},
"value": {
"type": "string",
"example": "Verlof (bovenwettelijk)",
"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.\n",
"readOnly": true,
"x-loket-db-field": "Loket.vwVerlofSoortenMetAfwijkingen.Omschrijving"
},
"balanceExceedsYear": {
"type": "boolean",
"example": true,
"description": "Indicates whether the balance at the end of the year for this leave type carries over to the next year.\n",
"readOnly": true,
"x-loket-db-field": "Loket.vwVerlofSoortenMetAfwijkingen.JaaroverschrijdendSaldo",
"x-loket-implementation": "Dit veld is in de database view een ctJaNee veld. Dus 1 is true en 2 is false."
}
}
},
"origin": {
"type": "object",
"readOnly": true,
"properties": {
"leavePolicy": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The leave policy for which the record was created. Will only have a value if `meansOfCreation` indicates a leave policy\n\n`leavePolicy` is a metadata field within the employer context. Possible values can be managed by the user.",
"readOnly": true,
"x-loket-implementation": "Deze wordt wordt automatische gevuld als men een verlofregeling \"toepast\"/\"uitvoert\"",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (a GUID/UUID)",
"readOnly": false
},
"value": {
"type": "string",
"example": "Default leave Regulations",
"description": "The description of the leave regulation.\n",
"readOnly": true,
"x-loket-db-field": "Loket.verlofregeling.naam"
},
"leaveUnitType": {
"type": "object",
"format": "metadata",
"description": "The type of leave units either days or hours",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the leave unit Type.\n",
"readOnly": true,
"x-loket-db-field": "Loket.Verlofregeling.Eenheid"
},
"value": {
"type": "string",
"example": "Uren",
"description": "The description for the leave unit type\n",
"readOnly": true,
"x-loket-db-field": "dbo.ctVerlofEenheid.Omschrijving"
}
}
},
"accrualType": {
"type": "object",
"format": "metadata",
"description": "Indicates how leave is accrued (yearly, monthly or hourly)",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the `accrualType`\n",
"readOnly": true
},
"value": {
"type": "string",
"example": "Jaar",
"description": "The description for the `accrualType`\n",
"readOnly": true
}
}
}
}
},
"meansOfCreation": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "The means of creation of the record",
"x-loket-implementation": "Deze waarde wordt altijd op individueel gezet bij de POST van dit endpoint.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the means of creation\n",
"readOnly": true,
"x-loket-db-field": "Loket.Verlof.herkomst"
},
"value": {
"type": "string",
"example": "individual",
"description": "The description for the leave unit type\n",
"readOnly": true,
"x-loket-db-field": "dbo.ctVerlofHerkomst.Omschrijving"
}
}
}
}
},
"comment": {
"type": [
"string",
"null"
],
"example": "some comment",
"readOnly": false,
"maxLength": 4000
},
"relatedLeaveRequest": {
"type": [
"object",
"null"
],
"readOnly": true,
"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.",
"x-loket-implementation": "Via het loket.verlof.VerlofaanvraagId naar loket.verlofaanvraag gaan om het externID op tehalen (let op de multipart sleutel)",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (a GUID/UUID)",
"readOnly": false
}
}
},
"relatedLeave": {
"type": [
"object",
"null"
],
"readOnly": true,
"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\n\nThe 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).",
"x-loket-implementation": "simpel weg kijken of er nog andere verlofboekingen zijn met de zelfde waarde voor loket.verlof.VerlofaanvraagId (als deze niet null is)",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (a GUID/UUID)",
"readOnly": false
}
}
}
}
},
"proposedLeaveHoursResponse": {
"properties": {
"employmentId": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (a GUID/UUID)",
"readOnly": true
},
"proposedLeaveHours": {
"type": "number",
"format": "double",
"example": 8,
"description": "The proposed number of leave hours",
"readOnly": true
},
"methodOfCalculation": {
"type": "string",
"example": "Ploeguren",
"description": "Indicates which method was used to calculate the proposed leave hours.",
"readOnly": true
},
"additionalInformation": {
"type": [
"string",
"null"
],
"example": "Additional information on the calculation.",
"description": "Provides additional information on the calculation.",
"readOnly": true
}
}
},
"commentEmployeePut": {
"type": [
"string",
"null"
],
"description": "The comment left by the employee",
"example": "Vakantie naar Spanje",
"maxLength": 4000,
"readOnly": true,
"x-loket-db-field": "Loket.Verlofaanvraag.OpmerkingAanvrager",
"x-loket-implementation": "Een lege string in de database wordt in de API teruggegeven als NULL."
},
"commentHandlerPut": {
"type": [
"string",
"null"
],
"description": "The comment left by the person handling the leave request",
"example": "Fijne vakantie!",
"maxLength": 4000,
"readOnly": false,
"x-loket-db-field": "Loket.Verlofaanvraag.OpmerkingBehandelaar",
"x-loket-implementation": "Een lege string in de database wordt in de API teruggegeven als NULL."
},
"leaveRequestPut": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"numberOfUnits": {
"$ref": "#/components/schemas/numberOfUnits-2"
},
"unitType": {
"$ref": "#/components/schemas/unitType"
},
"isAccrual": {
"$ref": "#/components/schemas/isAccrual"
},
"startDate": {
"$ref": "#/components/schemas/startDate-3"
},
"endDate": {
"$ref": "#/components/schemas/endDate-3"
},
"leaveType": {
"$ref": "#/components/schemas/leaveType"
},
"leaveRequestStatus": {
"$ref": "#/components/schemas/leaveRequestStatus"
},
"submittedOn": {
"$ref": "#/components/schemas/submittedOn"
},
"submittedBy": {
"$ref": "#/components/schemas/employeeBasic"
},
"handledTime": {
"$ref": "#/components/schemas/handledTime"
},
"handledBy": {
"$ref": "#/components/schemas/handledBy"
},
"commentEmployee": {
"$ref": "#/components/schemas/commentEmployeePut"
},
"commentHandler": {
"$ref": "#/components/schemas/commentHandlerPut"
},
"currentlyAvailableUnits": {
"$ref": "#/components/schemas/currentlyAvailableUnits"
}
}
},
"leaveBalance": {
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year to which the balance of the leave type applies.\n",
"example": 2019,
"minimum": 2000,
"maximum": 9999,
"readOnly": true
},
"leaveType": {
"type": "object",
"format": "metadata",
"description": "The type of leave requested by the employee\n`leaveType` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the leave type.\n",
"readOnly": true,
"x-loket-db-field": "Loket.Verlof.Soort"
},
"value": {
"type": "string",
"example": "Verlof (bovenwettelijk)",
"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.\n",
"readOnly": true,
"x-loket-db-field": "Loket.vwVerlofSoortenMetAfwijkingen.Omschrijving"
},
"balanceExceedsYear": {
"type": "boolean",
"example": true,
"description": "Indicates whether the balance at the end of the year for this leave type carries over to the next year.\n",
"readOnly": true,
"x-loket-db-field": "Loket.vwVerlofSoortenMetAfwijkingen.JaaroverschrijdendSaldo",
"x-loket-implementation": "Dit veld is in de database view een ctJaNee veld. Dus 1 is true en 2 is false."
}
}
},
"balancePreviousYear": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 20,
"description": "The remaining leave balance from the previous year for the leave type\n",
"readOnly": true,
"x-loket-implementation": "0 wanneer verlofsoort niet jaaroverschrijdend is (houd rekening met afwijkende verlofsoorten). Anders de optelsom van opbouw (+) en opname (-) voor de verlofsoort over alle voorgaande jaren."
},
"accrual": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 30,
"description": "The amount of leave units accrued for the leave type in the year\n",
"readOnly": true,
"x-loket-implementation": "De optelsom van alle opbouw verlofboekingen voor de verlofsoort in dit jaar"
},
"usageTotal": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 10,
"description": "The total amount of leave units used for the leave type in the year.\n",
"readOnly": true,
"x-loket-implementation": "De optelsom van alle opname verlofboekingen voor de verlofsoort in dit jaar"
},
"usageThroughToday": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 8,
"description": "The amount of leave units used for the leave type starting from the beginning of the year up to and including the referenceDate.\n",
"readOnly": true
},
"usageAfterToday": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 2,
"description": "The amount of leave units used for the leave type in the year after the referenceDate.\n",
"minimum": 0,
"readOnly": true
},
"usageFirstHalfYear": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 2,
"description": "The amount of leave units used for the leave type in the first half of the year\n",
"minimum": 0,
"readOnly": true
},
"balance": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 40,
"description": "The remaining leave balance for the year and leave type. The balance takes into account the leave usage in the future.\n",
"readOnly": true
},
"unitType": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.",
"readOnly": true,
"x-loket-implementation": "Een \"gecalculeerd\" veld (LOK-3745) * Voor een dienstverband met 1 of meerdere gekoppelde verlofregelingen met allemaal dezelfde verlofeenheid, wordt die verlofeenheid getoond in de applicatie * Voor een dienstverband met meerdere gekoppelde verlofregelingen met _verschillende_ verlofeenheden (een vreemde inrichting), wordt er _geen_ verlofeenheid getoond in de applicatie * Voor een dienstverband _zonder_ gekoppelde verlofregelingen, wordt er _geen_ verlofeenheid getoond in de applicatie",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the unit type\n",
"readOnly": false,
"x-loket-db-field": "dbo.ctVerlofEenheid.code (op basis van de logica voor het hele object)"
},
"value": {
"type": "string",
"example": "Uren",
"description": "The description for the unit type\n",
"readOnly": true,
"x-loket-db-field": "dbo.ctVerlofEenheid.code"
}
}
},
"expires": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 15,
"description": "\n - This field is only relevant for the following leave types:
\n - Wettelijk verlof: Accrued statutory leave from previous years that expires on July 1 of the selected year.
\n - Bovenwettelijk verlof: Accrued extra-legal leave from 5 years ago and earlier, which expires on Jan 1 of the selected year + 1.
\n - Verlof: The sum of the two leave types above.
\n
\n",
"readOnly": true
}
}
},
"department": {
"type": "object",
"format": "metadata",
"description": "The department of the employment.\n\n`department` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "loket.WerknemerFunctie.Afdeling omzetten naar guid"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.Afdeling.Nummer"
},
"description": {
"type": "string",
"example": "Verkoop",
"readOnly": true,
"x-loket-db-field": "Loket.Afdeling.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.Afdeling bevat de afdelingen voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
},
"function-2": {
"type": "object",
"format": "metadata",
"description": "The function of the employment.\n\n`function` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "loket.WerknemerFunctie.FunctieID en dan in loket.functie het externId ophalen"
},
"description": {
"type": "string",
"example": "Directeur",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.Functie.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.Functie bevat de functies voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
},
"group": {
"type": [
"string",
"null"
],
"example": "internal",
"maxLength": 5,
"readOnly": true,
"x-loket-db-field": "Loket.Functie.functiegroup",
"x-loket-implementation": "Let op: de tabel Loket.Functie bevat de functies voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
},
"standardFunction": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The standard (cao)function of the employment.\n\n`standardFunction` is a metadata field within the payroll administration context. Possible values can be managed by the user.",
"x-loket-implementation": "indien nvt dan NULL",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "loket.WerknemerFunctie.StandaardFunctieID"
},
"value": {
"type": "string",
"example": "Administrateur",
"readOnly": true,
"x-loket-db-field": "Ulsa.Standaardfunctie.Omschrijving",
"x-loket-implementation": "Let op: de tabel Ulsa.StandaardFunctie bevat de standaard functies voor alle werkgevers,loonmodellen en cao's. Filteren op (ulsa) werkgever is dus noodzakelijk."
},
"code": {
"type": [
"string",
"null"
],
"example": "A21",
"minLength": 1,
"maxLength": 6,
"readOnly": true,
"x-loket-db-field": "Ulsa.Standaardfunctie.code",
"x-loket-implementation": "Let op: de tabel Ulsa.StandaardFunctie bevat de standaard functies voor alle werkgevers,loonmodellen en cao's. Filteren op (ulsa) werkgever is dus noodzakelijk."
},
"category": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "loket.Standaardfunctie.categorie"
}
}
},
"deviatingFunctionGroup": {
"type": [
"string",
"null"
],
"example": "9A",
"minLength": 1,
"maxLength": 5,
"description": "The deviating function group description of the employment. Only applies when a deviating function description is defined.",
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerFunctie.Functiegroep"
},
"deviatingFunctionDescription": {
"type": [
"string",
"null"
],
"example": "Directeur",
"description": "The deviating function description of the employment. This description deviates from the value of the `function` field.",
"minLength": 1,
"maxLength": 50,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerFunctie.Functieomschrijving"
},
"placeOfEmployment": {
"type": [
"string",
"null"
],
"example": "Amsterdam office",
"description": "The standard working location (standplaats) for the employment.",
"minLength": 1,
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerFunctie.Standplaats"
},
"year": {
"type": "integer",
"format": "int32",
"description": "The year to which the balance of the leave type applies.\n",
"example": 2019,
"minimum": 2000,
"maximum": 9999,
"readOnly": true
},
"leaveType-3": {
"type": "object",
"format": "metadata",
"description": "The type of leave requested by the employee\n`leaveType` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the leave type.\n",
"readOnly": true,
"x-loket-db-field": "Loket.Verlof.Soort"
},
"value": {
"type": "string",
"example": "Verlof (bovenwettelijk)",
"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.\n",
"readOnly": true,
"x-loket-db-field": "Loket.vwVerlofSoortenMetAfwijkingen.Omschrijving"
},
"balanceExceedsYear": {
"type": "boolean",
"example": true,
"description": "Indicates whether the balance at the end of the year for this leave type carries over to the next year.\n",
"readOnly": true,
"x-loket-db-field": "Loket.vwVerlofSoortenMetAfwijkingen.JaaroverschrijdendSaldo",
"x-loket-implementation": "Dit veld is in de database view een ctJaNee veld. Dus 1 is true en 2 is false."
}
}
},
"balancePreviousYear": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 20,
"description": "The remaining leave balance from the previous year for the leave type\n",
"readOnly": true,
"x-loket-implementation": "0 wanneer verlofsoort niet jaaroverschrijdend is (houd rekening met afwijkende verlofsoorten). Anders de optelsom van opbouw (+) en opname (-) voor de verlofsoort over alle voorgaande jaren."
},
"accrual": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 30,
"description": "The amount of leave units accrued for the leave type in the year\n",
"readOnly": true,
"x-loket-implementation": "De optelsom van alle opbouw verlofboekingen voor de verlofsoort in dit jaar"
},
"usageTotal": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 10,
"description": "The total amount of leave units used for the leave type in the year.\n",
"readOnly": true,
"x-loket-implementation": "De optelsom van alle opname verlofboekingen voor de verlofsoort in dit jaar"
},
"usageThroughReferenceDate": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 8,
"description": "The amount of leave units used for the leave type starting from the beginning of the year up to and `referenceDate` \n",
"readOnly": true
},
"usageAfterReferenceDate": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 2,
"description": "The amount of leave units used for the leave type in the year after `referenceDate`\n",
"minimum": 0,
"readOnly": true
},
"usageFirstHalfYear": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 2,
"description": "The amount of leave units used for the leave type in the first half of the year\n",
"minimum": 0,
"readOnly": true
},
"balance": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 40,
"description": "The remaining leave balance for the year and leave type. The balance takes into account the leave usage in the future.\n",
"readOnly": true
},
"expires": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 15,
"description": "\n - This field is only relevant for the following leave types:
\n - Wettelijk verlof: Accrued statutory leave from previous years that expires on July 1 of the selected year.
\n - Bovenwettelijk verlof: Accrued extra-legal leave from 5 years ago and earlier, which expires on Jan 1 of the selected year + 1.
\n - Verlof: The sum of the two leave types above.
\n
\n",
"readOnly": true
},
"leaveBalanceEmployer": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"$ref": "#/components/schemas/startDate-4"
},
"historicalStartDate": {
"$ref": "#/components/schemas/historicalStartDate"
},
"endDate": {
"$ref": "#/components/schemas/endDate-5"
},
"payrollAdministration": {
"$ref": "#/components/schemas/payrollAdministration2019-12-16"
},
"nonPayrollAdministration": {
"$ref": "#/components/schemas/nonPayrollAdministration2019-12-16"
},
"incomeRelationshipNumber": {
"$ref": "#/components/schemas/incomeRelationshipNumber"
},
"employee": {
"$ref": "#/components/schemas/employeeBasic"
},
"organizationalEntity": {
"type": "object",
"readOnly": true,
"properties": {
"startDate": {
"$ref": "#/components/schemas/startDate-5"
},
"endDate": {
"$ref": "#/components/schemas/endDate-6"
},
"department": {
"$ref": "#/components/schemas/department"
},
"function": {
"$ref": "#/components/schemas/function-2"
},
"standardFunction": {
"$ref": "#/components/schemas/standardFunction"
},
"deviatingFunctionGroup": {
"$ref": "#/components/schemas/deviatingFunctionGroup"
},
"deviatingFunctionDescription": {
"$ref": "#/components/schemas/deviatingFunctionDescription"
},
"placeOfEmployment": {
"$ref": "#/components/schemas/placeOfEmployment"
}
}
},
"leaveBalance": {
"type": "array",
"items": {
"type": "object",
"properties": {
"year": {
"$ref": "#/components/schemas/year"
},
"leaveType": {
"$ref": "#/components/schemas/leaveType-3"
},
"balancePreviousYear": {
"$ref": "#/components/schemas/balancePreviousYear"
},
"accrual": {
"$ref": "#/components/schemas/accrual"
},
"usageTotal": {
"$ref": "#/components/schemas/usageTotal"
},
"usageThroughReferenceDate": {
"$ref": "#/components/schemas/usageThroughReferenceDate"
},
"usageAfterReferenceDate": {
"$ref": "#/components/schemas/usageAfterReferenceDate"
},
"usageFirstHalfYear": {
"$ref": "#/components/schemas/usageFirstHalfYear"
},
"balance": {
"$ref": "#/components/schemas/balance"
},
"expires": {
"$ref": "#/components/schemas/expires"
}
}
}
}
}
},
"leaveBalanceEmployerWithWorth": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"startDate": {
"$ref": "#/components/schemas/startDate-4"
},
"historicalStartDate": {
"$ref": "#/components/schemas/historicalStartDate"
},
"endDate": {
"$ref": "#/components/schemas/endDate-5"
},
"payrollAdministration": {
"$ref": "#/components/schemas/payrollAdministration2019-12-16"
},
"nonPayrollAdministration": {
"$ref": "#/components/schemas/nonPayrollAdministration2019-12-16"
},
"incomeRelationshipNumber": {
"$ref": "#/components/schemas/incomeRelationshipNumber"
},
"employee": {
"$ref": "#/components/schemas/employeeBasic"
},
"organizationalEntity": {
"type": "object",
"readOnly": true,
"properties": {
"startDate": {
"$ref": "#/components/schemas/startDate-5"
},
"endDate": {
"$ref": "#/components/schemas/endDate-6"
},
"department": {
"$ref": "#/components/schemas/department"
},
"function": {
"$ref": "#/components/schemas/function-2"
},
"standardFunction": {
"$ref": "#/components/schemas/standardFunction"
},
"deviatingFunctionGroup": {
"$ref": "#/components/schemas/deviatingFunctionGroup"
},
"deviatingFunctionDescription": {
"$ref": "#/components/schemas/deviatingFunctionDescription"
},
"placeOfEmployment": {
"$ref": "#/components/schemas/placeOfEmployment"
}
}
},
"leaveBalance": {
"type": "array",
"items": {
"type": "object",
"properties": {
"year": {
"$ref": "#/components/schemas/year"
},
"leaveType": {
"$ref": "#/components/schemas/leaveType-3"
},
"balancePreviousYear": {
"$ref": "#/components/schemas/balancePreviousYear"
},
"accrual": {
"$ref": "#/components/schemas/accrual"
},
"usageTotal": {
"$ref": "#/components/schemas/usageTotal"
},
"usageThroughReferenceDate": {
"$ref": "#/components/schemas/usageThroughReferenceDate"
},
"usageAfterReferenceDate": {
"$ref": "#/components/schemas/usageAfterReferenceDate"
},
"usageFirstHalfYear": {
"$ref": "#/components/schemas/usageFirstHalfYear"
},
"balance": {
"$ref": "#/components/schemas/balance"
},
"expires": {
"$ref": "#/components/schemas/expires"
},
"worth": {
"type": "number",
"format": "double",
"pattern": "^-?(0|([1-9][0-9]*))(\\.\\d{1,2})?$",
"example": 15,
"description": "The worth of the leave balance in euros\n",
"readOnly": true
}
}
}
}
}
},
"groupBy": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"description": {
"type": "string",
"example": "Verkoop Binnendienst",
"readOnly": true,
"maxLength": 50,
"description": "The description of the groupBy, either the department or function\n"
}
}
},
"leaveBalanceEmployerGroupedBy": {
"properties": {
"totals": {
"type": "array",
"description": "Returns the total sum of a leave type for all employments ",
"items": {
"type": "object",
"properties": {
"year": {
"$ref": "#/components/schemas/year"
},
"leaveType": {
"$ref": "#/components/schemas/leaveType-3"
},
"balancePreviousYear": {
"$ref": "#/components/schemas/balancePreviousYear"
},
"accrual": {
"$ref": "#/components/schemas/accrual"
},
"usageTotal": {
"$ref": "#/components/schemas/usageTotal"
},
"usageThroughReferenceDate": {
"$ref": "#/components/schemas/usageThroughReferenceDate"
},
"usageAfterReferenceDate": {
"$ref": "#/components/schemas/usageAfterReferenceDate"
},
"balance": {
"$ref": "#/components/schemas/balance"
}
}
}
},
"groups": {
"type": "array",
"description": "Returns the total sum of a leave type for all employments in the given group by",
"items": {
"type": "object",
"properties": {
"group": {
"$ref": "#/components/schemas/groupBy"
},
"year": {
"$ref": "#/components/schemas/year"
},
"leaveType": {
"$ref": "#/components/schemas/leaveType-3"
},
"balancePreviousYear": {
"$ref": "#/components/schemas/balancePreviousYear"
},
"accrual": {
"$ref": "#/components/schemas/accrual"
},
"usageTotal": {
"$ref": "#/components/schemas/usageTotal"
},
"usageThroughReferenceDate": {
"$ref": "#/components/schemas/usageThroughReferenceDate"
},
"usageAfterReferenceDate": {
"$ref": "#/components/schemas/usageAfterReferenceDate"
},
"balance": {
"$ref": "#/components/schemas/balance"
}
}
}
}
}
},
"linkedLeavePolicy": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"value": {
"type": "string",
"example": "Default leave Regulation",
"description": "The description of the leave regulation.\n",
"readOnly": true,
"x-loket-db-field": "Loket.verlofregeling.naam"
},
"leaveUnitType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "If known indicates what the unit type (hours or days) is for `numberOfUnits`. Otherwise the field will be null.",
"readOnly": true,
"x-loket-implementation": "Een \"gecalculeerd\" veld (LOK-3745) * Voor een dienstverband met 1 of meerdere gekoppelde verlofregelingen met allemaal dezelfde verlofeenheid, wordt die verlofeenheid getoond in de applicatie * Voor een dienstverband met meerdere gekoppelde verlofregelingen met _verschillende_ verlofeenheden (een vreemde inrichting), wordt er _geen_ verlofeenheid getoond in de applicatie * Voor een dienstverband _zonder_ gekoppelde verlofregelingen, wordt er _geen_ verlofeenheid getoond in de applicatie",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the unit type\n",
"readOnly": true,
"x-loket-db-field": "dbo.ctVerlofEenheid.code (op basis van de logica voor het hele object)"
},
"value": {
"type": "string",
"example": "Uren",
"description": "The description for the unit type\n",
"readOnly": true,
"x-loket-db-field": "dbo.ctVerlofEenheid.code"
}
}
}
}
},
"linkedLeavePoliciesPatch": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (GUID/UUID) of the leave policy",
"readOnly": false
},
"action": {
"type": "string",
"enum": [
"link",
"unlink"
],
"description": "The action to perform.",
"readOnly": false
}
},
"required": [
"id",
"action"
]
},
"leaveImportData": {
"properties": {
"employerNumber": {
"type": "integer",
"format": "int32",
"example": 20720,
"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).",
"readOnly": true
},
"payrollEmployeeNumber": {
"type": "integer",
"format": "int32",
"example": 202,
"description": "The number of the employment in relation to the payroll administration.",
"readOnly": true
},
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 156,
"description": "The employee number to uniquely identify an employee within an employer\n",
"readOnly": false
},
"formattedName": {
"type": "string",
"example": "Jong, I",
"description": "preformated user name for displaying. \\\\\", \\\"\\\\\" \\\"\\",
"readOnly": true
},
"startDate": {
"type": "string",
"format": "date",
"example": "2023-11-01",
"description": "The start date of the leave",
"readOnly": false
},
"endDate": {
"type": "string",
"format": "date",
"example": "2023-11-30",
"description": "The end date of the leave",
"readOnly": false
},
"leaveTypeKey": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the leave type.\n",
"readOnly": false
},
"isAccrual": {
"type": "integer",
"enum": [
1,
-1
],
"description": "Indicates whether the request is for accrual of leave.\n- -1 will result in a reduction of the employee's leave entitlement\n- 1 will result in an increase of the employee's leave entitlement\n",
"readOnly": false
},
"numberOfUnits": {
"type": "number",
"format": "double",
"example": 0,
"pattern": "^(\\d{1,3})(\\.\\d{1,2})?$",
"description": "The number of leave units requested",
"minimum": 0,
"maximum": 999.99,
"readOnly": false
}
}
},
"leave-2": {
"properties": {
"employmentId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"startDate": {
"type": "string",
"format": "date",
"example": "2022-10-21",
"description": "The start date for the leave.\n",
"readOnly": false
},
"endDate": {
"type": "string",
"format": "date",
"example": "2022-10-22",
"description": "The end date for the leave.\n",
"readOnly": false
},
"leaveType": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The id of the leavetype.\n",
"readOnly": false
},
"isAccrual": {
"type": "boolean",
"example": true,
"description": "Indicates whether the leave should be added(true) or subtracted(false).\n",
"readOnly": false
},
"numberOfUnits": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,6})(.\\d{1,2})?$",
"example": 4.5,
"description": "The amount of leave.\n",
"maximum": 999.99,
"readOnly": false
},
"comments": {
"type": [
"string",
"null"
],
"example": "This leave is added.",
"description": "Any comments on the leave.\n",
"maximum": 4000,
"readOnly": false
}
}
},
"payrollProcessOverview": {
"type": "object",
"properties": {
"payrollPeriod": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period\n",
"example": 2020,
"readOnly": true
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53])\n",
"example": 4,
"readOnly": true
},
"payrollPeriodId": {
"type": "integer",
"format": "int32",
"description": "The year and period of the payroll period\n",
"example": 202004,
"readOnly": true
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period to which the payroll period data applies\n",
"example": "2020-04-01",
"readOnly": true
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period to which the payroll period data applies\n",
"example": "2020-06-30",
"readOnly": true
}
}
},
"payrollTaxReturnPeriod": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll tax return period\n",
"example": 2020,
"readOnly": true
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 13])\n",
"example": 4,
"readOnly": true
},
"payrollTaxReturnPeriodId": {
"type": "integer",
"format": "int32",
"description": "The year and period of the payroll tax return period\n",
"example": 202001,
"readOnly": true
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period to which the payroll tax return period data applies\n",
"example": "2020-04-01",
"readOnly": true
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period to which the payroll tax return period data applies\n",
"example": "2020-06-30",
"readOnly": true
},
"lastPayrollPeriodId": {
"type": "integer",
"format": "int32",
"description": "The year and period identifying the last payroll period that is part of the payroll tax return period.\n",
"example": 202004,
"readOnly": true
}
}
},
"payroll": {
"type": "object",
"description": "Status and possible actions of the payroll process",
"properties": {
"payrollStatus": {
"type": "object",
"readOnly": true,
"description": "Status of the payroll process in the period.\nPossible statuses are:\n- 0\tInvalid\n- 1\tNot started\n- 2\tQueued\n- 3\tWaiting for approval\n- 4\tIncorrect and there is an approved preceding payrollrun\n- 5\tIncorrect\n- 6\tApproved \n- 7\tNo results\n- 8\tNo results and there is an approved preceding payrollrun\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true
},
"value": {
"type": "string",
"example": "Queued",
"readOnly": true
},
"payrollStatusAdditionalInfo": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "Additional information on the the status of the payroll process in the period.\n",
"properties": {
"key": {
"type": "string",
"example": "2.1",
"readOnly": true
},
"value": {
"type": "string",
"example": "The period has a payrollrun queued.",
"readOnly": true
}
}
}
}
},
"payrollPossibleActions": {
"type": "object",
"readOnly": true,
"description": "Possible actions for the payroll process in the period.\nPossible actions are:\n- 0\tNone (no action possible)\n- 1\tReady to proces\n- 2\tStart\n- 3\tRestart\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": true
},
"value": {
"type": "string",
"example": "None",
"readOnly": true
},
"payrollPossibleActionsAdditionalInfo": {
"type": "object",
"readOnly": true,
"description": "Additional information on the possible action of the payroll process in the period.\n",
"properties": {
"key": {
"type": "string",
"example": "0.7",
"readOnly": true
},
"value": {
"type": "string",
"example": "The period has a payrollrun queued.",
"readOnly": true
}
}
}
}
},
"typeOfInitiationLastPayrollRun": {
"type": "string",
"enum": [
"regular",
"withoutEmploymentData"
],
"readOnly": true,
"description": "Indicates whether the run is completed with or withour employments."
}
}
},
"journal": {
"type": "object",
"description": "Status and possible actions of the journal process",
"properties": {
"journalStatus": {
"type": "object",
"readOnly": true,
"description": "Status of the journal process in the period.\nPossible statuses are:\n- 0\tInvalid\n- 1\tQueued\n- 2\tExporting\n- 3\tIncorrect\n- 4\tIncorrect and preceding journalrun\n- 5\tNo results\n- 6\tNo results and preceding journalrun \n- 7\tLast export failed\n- 8\tJournal ready\n- 9 Export failed\n- 10 Not started\n- 11 Exported\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true
},
"value": {
"type": "string",
"example": "Queued",
"readOnly": true
},
"journalStatusAdditionalInfo": {
"type": "object",
"readOnly": true,
"description": "Additional information on the the status of the payroll process in the period.\n",
"properties": {
"key": {
"type": "string",
"example": "2.1",
"readOnly": true
},
"value": {
"type": "string",
"example": "The period has a journalrun ready for export",
"readOnly": true
}
}
}
}
},
"journalPossibleActions": {
"type": "object",
"readOnly": true,
"description": "Possible actions for the journal process in the period.\nPossible actions are:\n- 0\tNone (no action possible)\n- 1\tStart\n- 2 Export\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": true
},
"value": {
"type": "string",
"example": "None",
"readOnly": true
},
"journalPossibleActionsAdditionalInfo": {
"type": "object",
"readOnly": true,
"description": "Additional information on the possible action of the journal process in the period.\n",
"properties": {
"key": {
"type": "string",
"example": "0.7",
"readOnly": true
},
"value": {
"type": "string",
"example": "The period has a journalrun queued.",
"readOnly": true
}
}
}
}
}
}
},
"payrollTaxReturn": {
"type": "object",
"description": "Status and possible actions of the payroll taxReturn process",
"properties": {
"payrollTaxReturnStatus": {
"type": "object",
"readOnly": true,
"description": "Status of the payroll taxreturn process in the period.\nPossible statuses are: \n- 0\tInvalid\n- 1\tNot started\n- 2\tQueued\n- 3\tWaiting for approval\n- 5\tIncorrect\n- 6\tApproved\n- 9\tApproved and sent\n- 10\tNot available\n- 11\tCancelled\n- 12\tDeleted\n- 13\tBlank\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 6,
"readOnly": true
},
"value": {
"type": "string",
"example": "Done",
"readOnly": true
},
"payrollTaxReturnStatusAdditionalInfo": {
"type": "object",
"readOnly": true,
"description": "Additional information on the status of the payroll tax return process in the period.\n",
"properties": {
"key": {
"type": "string",
"example": "2",
"readOnly": true
},
"value": {
"type": "string",
"example": "The period has a payrolltaxrun queued.",
"readOnly": true
}
}
}
}
},
"payrollTaxReturnPossibleActions": {
"type": "object",
"readOnly": true,
"description": "Possible actions for the payroll tax return process in the period.\nPossible actions are:\n- 0\tNone (no action possible)\n- 1\tReady to proces\n- 2\tStart\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true
},
"value": {
"type": "string",
"example": "Start",
"readOnly": true
},
"payrollTaxReturnPossibleActionsAdditionalInfo": {
"type": "object",
"readOnly": true,
"description": "Additional information on the possible action of the payroll tax return process in the period.\n",
"properties": {
"key": {
"type": "string",
"example": "0.13",
"readOnly": true
},
"value": {
"type": "string",
"example": "There is a queued payrolltaxreturn.",
"readOnly": true
}
}
}
}
},
"initiateIdealPayment": {
"type": "object",
"readOnly": true,
"description": "Indicates whether the payroll tax can be payed by means of IDEAL.\nPossible values:\n- Ideal Payment is possible (key = 0)\n- Ideal Payment not possible for total amount (<=0 of >=50.000) (key = 1)\n- Ideal Payment not possible from a \"G-rekening\" (key = 2)\n- Ideal Payment not possible there is a pending payment (key = 3)\n- Ideal Payment not possible the payment has already been processed and accepted (key = 4)\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": true
},
"value": {
"type": "string",
"example": "Ideal Payment is possible",
"readOnly": true
}
}
}
}
},
"pensionDeclaration": {
"type": "array",
"items": {
"type": "object",
"description": "Status and possible actions of the pensiondeclaration process",
"properties": {
"pensionDeclarationStatus": {
"type": "object",
"readOnly": true,
"description": "Status of the pensiondeclaration process in the period.\nPossible statuses are: \n- 0\tInvalid\n- 1\tNot started\n- 2\tQueued\n- 3\tWaiting for approval\n- 5\tIncorrect\n- 6\tApproved\n- 9\tApproved and sent\n- 10\tNot available\n- 11\tCancelled\n- 12\tDeleted\n- 13\tBlank\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 6,
"readOnly": true
},
"value": {
"type": "string",
"example": "Done",
"readOnly": true
},
"pensionDeclarationStatusAdditionalInfo": {
"type": "object",
"readOnly": true,
"description": "Additional information on the status of the pensiondeclaration process in the period.\n",
"properties": {
"key": {
"type": "string",
"example": "2",
"readOnly": true
},
"value": {
"type": "string",
"example": "The period has a pensiondeclaration queued.",
"readOnly": true
}
}
}
}
},
"pensionDeclarationPossibleActions": {
"type": "object",
"readOnly": true,
"description": "Possible actions for the pensiondeclaration process in the period.\nPossible actions are:\n- 0\tNone (no action possible)\n- 1\tReady to proces\n- 2\tStart\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true
},
"value": {
"type": "string",
"example": "Start",
"readOnly": true
},
"pensionDeclarationPossibleActionsAdditionalInfo": {
"type": "object",
"readOnly": true,
"description": "Additional information on the possible action of the pensiondeclaration process in the period.\n",
"properties": {
"key": {
"type": "string",
"example": "UPAC014",
"readOnly": true
},
"value": {
"type": "string",
"example": "There is a queued pensiondeclaration.",
"readOnly": true
}
}
}
}
},
"pensionDeclarationAdministratorType": {
"type": "string",
"enum": [
"UPA",
"APG"
],
"description": "The type of Pension declaration",
"readOnly": false
},
"pensionDeclarationExternalParty": {
"type": "object",
"readOnly": true,
"description": "External party (externe partij)",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 13,
"readOnly": true
},
"value": {
"type": "string",
"example": "PFZW (UPA)",
"readOnly": true
}
}
}
}
}
},
"pawwDeclaration": {
"type": "object",
"description": "Status and possible actions of the pawwDeclaration process",
"properties": {
"pawwDeclarationStatus": {
"type": "object",
"readOnly": true,
"description": "Status of the pawwDeclaration process in the period.\nPossible statuses are: \n- 0\tInvalid\n- 1\tNot started\n- 2\tQueued\n- 3\tWaiting for approval\n- 5\tIncorrect\n- 6\tApproved\n- 9\tApproved and sent\n- 10\tNot available\n- 11\tCancelled\n- 12\tDeleted\n- 13\tBlank\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 6,
"readOnly": true
},
"value": {
"type": "string",
"example": "Done",
"readOnly": true
},
"pawwDeclarationStatusAdditionalInfo": {
"type": "object",
"readOnly": true,
"description": "Additional information on the status of the pawwDeclaration process in the period.\n",
"properties": {
"key": {
"type": "string",
"example": "2",
"readOnly": true
},
"value": {
"type": "string",
"example": "The period has a pawwDeclaration queued.",
"readOnly": true
}
}
}
}
},
"pawwDeclarationPossibleActions": {
"type": "object",
"readOnly": true,
"description": "Possible actions for the pawwDeclaration process in the period.\nPossible actions are:\n- 0\tNone (no action possible)\n- 1\tReady to proces\n- 2\tStart\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true
},
"value": {
"type": "string",
"example": "Start",
"readOnly": true
},
"pawwDeclarationPossibleActionsAdditionalInfo": {
"type": "object",
"readOnly": true,
"description": "Additional information on the possible action of the pawwDeclaration process in the period.\n",
"properties": {
"key": {
"type": "string",
"example": "UPAC014",
"readOnly": true
},
"value": {
"type": "string",
"example": "There is a queued pawwDeclaration.",
"readOnly": true
}
}
}
}
},
"pensionAdministratorType": {
"type": "string",
"enum": [
"UPA",
"APG"
],
"description": "The type of Pension declaration",
"readOnly": false
}
}
}
}
},
"payrollRun": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"payrollPeriod": {
"type": "object",
"format": "metadata",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period the record relates to",
"example": 2023,
"readOnly": false
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period number of the payroll period the record relates to",
"example": 2,
"readOnly": false
}
}
},
"payrollRunStatus": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 9,
"description": "The key indicating the current status of the payroll run.",
"readOnly": true,
"x-loket-db-field": "Ulsa.VerloningsRun.Status"
},
"value": {
"type": "string",
"example": "Verloning goedgekeurd.",
"description": "The value describing the current status of the payroll run.\n* Staat klaar voor verloning. (key = 0)\n* Verloning gereed. (key = 1)\n* Proforma verloning gereed. (key = 2)\n* Verwijderd door gebruiker (key = 5)\n* Verloning geannuleerd door gebruiker. (key = 6)\n* Fout tijdens verloning. (key = 7)\n* Geen loonresultaten, verloning geannuleerd. (key = 8)\n* Verloning goedgekeurd. (key = 9)\n",
"readOnly": true,
"x-loket-db-field": "dbo.ctStatusVerloningsRun.Omschrijving"
}
}
},
"textPaySlip": {
"type": [
"string",
"null"
],
"description": "An optional text provided by an authorized user that will be displayed on the pay slip.",
"maxLength": 25,
"readOnly": false,
"x-loket-db-field": "Ulsa.VerloningsRun.TekstStrook",
"x-loket-implementation": "Een lege string in de database wordt in de API teruggegeven als NULL."
},
"textPayment": {
"type": [
"string",
"null"
],
"description": "An optional text provided by an authorized user that will be displayed as a description for the payment.",
"maxLength": 32,
"readOnly": false,
"x-loket-db-field": "Ulsa.VerloningsRun.TekstExcasso",
"x-loket-implementation": "Een lege string in de database wordt in de API teruggegeven als NULL."
},
"requestTime": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the payroll run was requested by the user",
"readOnly": true,
"x-loket-db-field": "Ulsa.VerloningsRun.DatumOpdracht"
},
"processingFinishedTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "Date-time when the calculations of the wages was finished",
"readOnly": true,
"x-loket-db-field": "Ulsa.VerloningsRun.DatumVerloning"
},
"approvalTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the payroll run was approved by the user",
"readOnly": true,
"x-loket-db-field": "Ulsa.VerloningsRun.DatumAfgehandeld"
},
"sequenceNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"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,
"readOnly": true,
"x-loket-db-field": "Ulsa.VerloningsRun.Volgnummer",
"x-loket-implementation": "Een 0 waarde in de database wordt in de API teruggegeven als NULL. Hierdoor is dit veld in de API nullable terwijl dit in de database niet zo is."
},
"textTariffPaySlip": {
"type": [
"string",
"null"
],
"description": "An additional text to be displayed on the tariff payslip.",
"maxLength": 25,
"readOnly": false,
"x-loket-db-field": "Ulsa.VerloningsRun.TekstStrookBijzonderTarief",
"x-loket-implementation": "Een lege string in de database wordt in de API teruggegeven als NULL."
},
"availableForEmployeeDate": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The date on which the pay slips will be available to employees.",
"example": "2018-05-08",
"readOnly": false,
"x-loket-db-field": "Ulsa.VerloningsRun.DatumBeschikbaarEss"
},
"sendEmailToEmployee": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether an email should be sent to the employees when the pay slip is available to them. NULL will be seen as false",
"readOnly": false,
"x-loket-db-field": "Ulsa.VerloningsRun.EssMailVersturen",
"x-loket-implementation": "Dit is een dbo.ctJaNee veld in de database en kan dus worden teruggegeven als een boolean in de API."
},
"requestedBy": {
"$ref": "#/components/schemas/userBasicNotNullable"
},
"approvedBy": {
"$ref": "#/components/schemas/userBasic"
},
"sequenceNumberApproved": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "An incremental number with a payrolling year to uniquely identify an approved payroll run.",
"readOnly": true,
"x-loket-db-field": "Ulsa.VerloningsRun.VolgnummerGoedgekeurd",
"x-loket-implementation": "Een 0 waarde in de database wordt in de API teruggegeven als NULL. Hierdoor is dit veld in de API nullable terwijl dit in de database niet zo is."
},
"removeTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The time at which the pay roll run was removed.",
"example": "2018-05-08T15:16:49+02:00",
"readOnly": true,
"x-loket-db-field": "Ulsa.VerloningsRun.DatumVerwijderd"
},
"removedBy": {
"$ref": "#/components/schemas/userBasic"
},
"methodOfCreation": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The key indicating how the payroll run was created.",
"readOnly": true,
"x-loket-db-field": "Ulsa.VerloningsRun.WijzeVanAanmaak",
"x-loket-implementation": "In de database kan dit veld null zijn maar omdat de default waarde 0 is, zal dit nooit het geval zijn. In de API kiezen we er dus voor om dit veld niet nullable te maken."
},
"value": {
"type": "string",
"example": "Individueel",
"description": "The value describing how the payroll run was created.",
"readOnly": true,
"x-loket-db-field": "dbo.ctWijzeVanAanmaak.Omschrijving"
}
}
},
"errorsAndWarnings": {
"type": "object",
"readOnly": true,
"properties": {
"hasErrors": {
"type": "boolean",
"description": "Indicates whether the payrollrun has errors",
"readOnly": true
},
"hasWarnings": {
"type": "boolean",
"example": true,
"description": "Indicates whether the payrollrun has warnings",
"readOnly": true
}
}
},
"payrollTaxReturnPeriod": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "Indicates the payrolltaxreturn period in which the payrollrun is included.",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period the record relates to",
"example": 2023,
"readOnly": false
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period number of the payroll period the record relates to",
"example": 2,
"readOnly": false
}
}
}
}
},
"availableForEmployeePatch": {
"type": "object",
"properties": {
"availableForEmployeeDate": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The date on which the pay slips will be available to employees.",
"example": "2018-05-08",
"readOnly": false,
"x-loket-db-field": "Ulsa.VerloningsRun.DatumBeschikbaarEss"
},
"sendEmailToEmployee": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether an email should be sent to the employees when the pay slip is available to them. NULL will be seen as false",
"readOnly": false,
"x-loket-db-field": "Ulsa.VerloningsRun.EssMailVersturen",
"x-loket-implementation": "Dit is een dbo.ctJaNee veld in de database en kan dus worden teruggegeven als een boolean in de API."
}
}
},
"payrollrunStatusPatch": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (GUID/UUID) of the payroll run.",
"readOnly": false
},
"action": {
"type": "string",
"enum": [
"confirm",
"cancel"
],
"description": "The action to perform on the payroll run",
"readOnly": false
}
},
"required": [
"id",
"action"
]
},
"periodReadyForPayroll": {
"type": "object",
"properties": {
"payrollPeriodId": {
"type": "integer",
"format": "int32",
"example": 202101,
"description": "The id for this specific payroll period.",
"readOnly": false
},
"emailAddressPeriodReadyForPayroll": {
"type": "array",
"format": "emailAddress",
"minItems": 1,
"maxItems": 10,
"example": [
"email@kantoor.nl",
"email2@kantoor.nl"
],
"description": "The email address(es) of the recipient(s)",
"readOnly": false,
"items": {
"type": "string",
"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])))$"
}
},
"userComment": {
"type": [
"string",
"null"
],
"maxLength": 1000,
"description": "A personal message from the sender.",
"example": "All mutations are done.",
"readOnly": false
}
}
},
"sepaFiles": {
"type": "object",
"x-loket-implementation": "Om de batches op te halen moet gekeken worden in de tabel Ulsa.InterpayPcgdBatch. Met ClientNummer, Jaar en VolgnummerRun kunnen de Ulsa.VerloningsRun en de Ulsa.InterpayBatch aan elkaar gelinkt worden. Voor ClientNummer moet eventueel in Ulsa.Werkgever worden gegekeken. !!!--->>> Aleen batches van soort 3 teruggeven! <<<---!!!",
"x-loket-implementation2": "in tegenstelling tot de werking van GUI 2 geeft de lijst altijd de BATCHes terug. Voor het downloaden van het totaal bestand bestaat een apart endpoint /v2/providers/employers/payrolladministrations/payrollruns/{payrollrunId}/totalsepafile",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true,
"x-loket-db-field": "Ulsa.InterpayPcgdBatch.externId"
},
"description": {
"type": "string",
"description": "Description of the sepa file",
"example": "SALARISBETALING PERIODE 9",
"maxLength": 32,
"readOnly": true,
"x-loket-db-field": "Ulsa.InterpayPcgdBatch.VasteOmschrijving",
"x-loket-implementation": "in tegenstelling tot de werking van GUI 2 wordt hier Ulsa.InterpayPcgdBatch.bankgirorekeningnummerOpdrachtgever niet terug gegeven.",
"x-loket-implementation2": "in de DB is dit veld nullable zover wij weten is dit veld nooit null mocht dat toch zo zijn wordt er een empty string teruggegeven."
}
}
},
"sepaHashes": {
"type": "object",
"properties": {
"sepaFileDescription": {
"type": "string",
"description": "Description of the sepa file",
"example": "SALARISBETALING PERIODE 9",
"maxLength": 32,
"readOnly": true
},
"hash": {
"type": "string",
"description": "The SHA-256 hash",
"pattern": "^[a-f0-9]{64}$",
"example": "cd2feea250047d4477a0276f864e9c223af66a73c305f872c31dc0cdfb709b1f",
"readOnly": true
}
}
},
"id-3": {
"type": "integer",
"format": "int32",
"example": 202001,
"description": "The id for this specific payroll period.",
"readOnly": true
},
"year-2": {
"type": "integer",
"format": "int32",
"description": "The payroll year",
"example": 2020,
"readOnly": true
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period number of the payroll period",
"example": 1,
"readOnly": true
},
"startDate-8": {
"type": "string",
"format": "date",
"description": "The first day of the payroll period",
"example": "2020-01-01",
"readOnly": true
},
"endDate-9": {
"type": "string",
"format": "date",
"description": "The last day of the payroll period",
"example": "2020-01-31",
"readOnly": true
},
"automaticProcessing": {
"type": [
"object",
"null"
],
"readOnly": true,
"properties": {
"createPayrollRunOn": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The date on which the payroll run for this period is automatically created (if all prerequisite are met).",
"example": "2020-01-18",
"readOnly": true
},
"hasAutomaticPayrollRunCreationBeenExecuted": {
"type": "boolean"
},
"approvePayrollRunOn": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The date on which the payroll run for this period is automatically approved (if all prerequisite are met).",
"example": "2020-01-23",
"readOnly": true
},
"hasAutomaticPayrollRunApprovalBeenExecuted": {
"type": "boolean"
}
}
},
"payrollPeriodType-2": {
"type": "object",
"readOnly": true,
"description": "Indicates the frequence of the payrolling process. Payrolling can be done on a montly, 4-weekly or weekly basis.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.code"
},
"value": {
"type": "string",
"example": "month",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.omschrijving"
}
}
},
"testYear-2": {
"type": "boolean",
"example": false,
"description": "Indicates whether the payroll year is a test year.\n\nIn 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. \nPlease 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.",
"readOnly": true,
"x-loket-db-field": "af te leiden uit de jaarinrichting van de administratie Ulsa.Jaar"
},
"payrollRuns": {
"type": "array",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"payrollRunStatus": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 9,
"description": "The key indicating the current status of the payroll run.",
"readOnly": false,
"x-loket-db-field": "Ulsa.VerloningsRun.Status"
},
"value": {
"type": "string",
"example": "Verloning goedgekeurd.",
"description": "The value describing the current status of the payroll run.",
"readOnly": true,
"x-loket-db-field": "dbo.ctStatusVerloningsRun.Omschrijving"
}
}
},
"sequenceNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"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,
"readOnly": true,
"x-loket-db-field": "Ulsa.VerloningsRun.Volgnummer",
"x-loket-implementation": "Een 0 waarde in de database wordt in de API teruggegeven als NULL. Hierdoor is dit veld in de API nullable terwijl dit in de database niet zo is."
},
"sequenceNumberApproved": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 3,
"description": "An incremental number with a payrolling year to uniquely identify an approved payroll run.",
"readOnly": true,
"x-loket-db-field": "Ulsa.VerloningsRun.VolgnummerGoedgekeurd",
"x-loket-implementation": "Een 0 waarde in de database wordt in de API teruggegeven als NULL. Hierdoor is dit veld in de API nullable terwijl dit in de database niet zo is."
},
"journalRuns": {
"type": "array",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"sequenceNumber": {
"type": "integer",
"format": "int32",
"description": "Ascending sequence number over ALL journal runs for the payroll administration.",
"example": 8,
"readOnly": true,
"x-loket-db-field": "Ulsa.JournaalRun.Volgnummer"
},
"journalRunStatus": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 4,
"description": "The key indicating the current status of the journal run.",
"readOnly": false,
"x-loket-db-field": "Ulsa.JournaalRun.Status"
},
"value": {
"type": "string",
"example": "Journaal gereed",
"description": "The value describing the current status of the payroll run.",
"readOnly": true,
"x-loket-db-field": "dbo.ctStatusJournaalRun.Omschrijving"
}
}
}
}
}
}
}
}
},
"payrollPeriods": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id-3"
},
"year": {
"$ref": "#/components/schemas/year-2"
},
"periodNumber": {
"$ref": "#/components/schemas/periodNumber"
},
"startDate": {
"$ref": "#/components/schemas/startDate-8"
},
"endDate": {
"$ref": "#/components/schemas/endDate-9"
},
"automaticProcessing": {
"$ref": "#/components/schemas/automaticProcessing"
},
"payrollPeriodType": {
"$ref": "#/components/schemas/payrollPeriodType-2"
},
"testYear": {
"$ref": "#/components/schemas/testYear-2"
},
"payrollRuns": {
"$ref": "#/components/schemas/payrollRuns"
}
}
},
"payrollPeriodsMinimized": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"year": {
"$ref": "#/components/schemas/year-2"
},
"periodNumber": {
"$ref": "#/components/schemas/periodNumber"
},
"startDate": {
"$ref": "#/components/schemas/startDate-8"
},
"endDate": {
"$ref": "#/components/schemas/endDate-9"
},
"payrollPeriodType": {
"$ref": "#/components/schemas/payrollPeriodType-2"
},
"testYear": {
"$ref": "#/components/schemas/testYear-2"
},
"hasApprovedPayrollRun": {
"type": "boolean",
"example": false,
"description": "Indicates if the payroll period has atleast 1 approved payrollrun",
"readOnly": true
},
"hasSuccessfulJournalRun": {
"type": "boolean",
"example": false,
"description": "Indicates if the payroll period has atleast 1 successful journalrun",
"readOnly": true
}
}
},
"payrollResults-2": {
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id",
"x-loket-implementation": "Loket.Dienstverband.ExternId"
},
"payrollPeriods": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payrollPeriod": {
"format": "metadata",
"type": "object",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period the record relates to",
"example": 2017,
"readOnly": false,
"x-loket-db-field": "Ulsa.LoonaangifteBericht.Jaar"
},
"periodNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "The period number of the payroll period the record relates to",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Ulsa.LoonaangifteBericht.Periode"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period for which the tax return message was created",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period for which the tax return message was created",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"testYear": {
"type": "boolean",
"example": false,
"description": "Indicates whether the payroll periode is part of a test year.\n\nIn 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. \nPlease 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.",
"readOnly": true,
"x-loket-db-field": "af te leiden uit de jaarinrichting van de administratie Ulsa.Jaar"
}
}
},
"payslipTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payslipType": {
"type": "object",
"format": "metadata",
"description": "The type of payslip on which underlying payroll run results will be booked. This is either normaal or bijzonder tarief.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Strook",
"x-loket-comment": "LET OP; hier gaat het om ulsaCode maar we willen teruggeven de loketCode (zie ctStrook)"
},
"value": {
"type": "string",
"example": "Normaal strook",
"readOnly": true,
"x-loket-db-field": "dbo.ctStrook.Omschrijving"
}
}
},
"payrollComponentResults": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payrollComponent": {
"type": "object",
"format": "metadata",
"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.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Component"
},
"value": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc. \n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Categorie"
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true,
"x-loket-db-field": "dbo.ctCategorie.omschrijving"
}
}
},
"column": {
"type": "object",
"format": "metadata",
"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.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 6,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Kolom",
"x-loket-implementation": "deze waarde kan 0 zijn met een betekenis, dus; niet vertalen naar NULL !"
},
"value": {
"type": "string",
"example": "Sociaalplichtig loon",
"readOnly": true,
"x-loket-db-field": "dbo.ctKolom.omschrijving"
}
}
},
"costsEmployer": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.KostenWerkgever"
},
"value": {
"type": "string",
"example": "+",
"readOnly": true,
"x-loket-db-field": "dbo.ctKostenWerkgever.Omschrijving"
}
}
}
}
},
"value": {
"type": "number",
"example": 40,
"description": "Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this.",
"readOnly": true,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Inhoud",
"x-loket-comment": "Maximum precision = 2"
},
"valueSpecialTariff": {
"type": "number",
"example": 144,
"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.",
"readOnly": true,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.InhoudTarief",
"x-loket-comment": "Maximum precision = 2"
}
}
}
}
}
}
}
}
}
}
}
},
"payrollPeriodCompare": {
"type": "object",
"properties": {
"payrollPeriod": {
"type": "object",
"format": "metadata",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period the record relates to",
"example": 2017,
"readOnly": false,
"x-loket-db-field": "Ulsa.LoonaangifteBericht.Jaar"
},
"periodNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "The period number of the payroll period the record relates to",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Ulsa.LoonaangifteBericht.Periode"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period for which the tax return message was created",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period for which the tax return message was created",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"testYear": {
"type": "boolean",
"example": false,
"description": "Indicates whether the payroll periode is part of a test year.\n\nIn 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. \nPlease 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.",
"readOnly": true,
"x-loket-db-field": "af te leiden uit de jaarinrichting van de administratie Ulsa.Jaar"
}
}
},
"numberOfPayrolledEmployments": {
"type": "integer",
"format": "int32",
"example": 34,
"minimum": 0,
"description": "The number of employments that where payrolled",
"readOnly": true
},
"payrollComponentResults": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payrollComponent": {
"type": "object",
"format": "metadata",
"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.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Component"
},
"value": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc. \n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Categorie"
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true,
"x-loket-db-field": "dbo.ctCategorie.omschrijving"
}
}
},
"column": {
"type": "object",
"format": "metadata",
"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.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 6,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Kolom",
"x-loket-implementation": "deze waarde kan 0 zijn met een betekenis, dus; niet vertalen naar NULL !"
},
"value": {
"type": "string",
"example": "Sociaalplichtig loon",
"readOnly": true,
"x-loket-db-field": "dbo.ctKolom.omschrijving"
}
}
},
"costsEmployer": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.KostenWerkgever"
},
"value": {
"type": "string",
"example": "+",
"readOnly": true,
"x-loket-db-field": "dbo.ctKostenWerkgever.Omschrijving"
}
}
}
}
},
"value": {
"type": "number",
"example": 40,
"description": "Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this.",
"readOnly": true,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Inhoud",
"x-loket-comment": "Maximum precision = 2"
},
"valueSpecialTariff": {
"type": "number",
"example": 144,
"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.",
"readOnly": true,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.InhoudTarief",
"x-loket-comment": "Maximum precision = 2"
}
}
}
}
}
},
"payrollResultsCompact": {
"type": "object",
"properties": {
"clientNumber": {
"type": "integer",
"format": "int32",
"example": 1234
},
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 14
},
"incomeRelationshipNumber": {
"type": "integer",
"format": "int32",
"example": 1
},
"formattedName": {
"type": "string",
"example": "Bos B"
},
"year": {
"type": "integer",
"format": "int32",
"example": 2024
},
"department": {
"type": [
"string",
"null"
],
"example": "Procurement",
"description": "The discription of the department of the employment."
},
"function": {
"type": [
"string",
"null"
],
"example": "Manager",
"description": "The discription of the function of the employment."
},
"gross": {
"type": "number",
"format": "double",
"example": 2400
},
"net": {
"type": "number",
"format": "double",
"example": 1684.51
},
"employerCosts": {
"type": "number",
"format": "double",
"example": 2561.47
},
"fte": {
"type": "number",
"format": "double",
"example": 2.8
}
}
},
"payrollComponentResults": {
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id"
},
"payrollComponentResults": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payrollPeriod": {
"type": "object",
"format": "metadata",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period the record relates to",
"example": 2017,
"readOnly": false,
"x-loket-db-field": "Ulsa.LoonaangifteBericht.Jaar"
},
"periodNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "The period number of the payroll period the record relates to",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Ulsa.LoonaangifteBericht.Periode"
}
}
},
"value": {
"type": "number",
"example": 40,
"description": "Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this.",
"readOnly": true,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Inhoud",
"x-loket-comment": "Maximum precision = 2"
},
"valueSpecialTariff": {
"type": "number",
"example": 144,
"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.",
"readOnly": true,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.InhoudTarief",
"x-loket-comment": "Maximum precision = 2"
}
}
}
}
}
},
"payrollPeriod-2": {
"type": "object",
"format": "metadata",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period the record relates to",
"example": 2017,
"readOnly": false,
"x-loket-db-field": "Ulsa.LoonaangifteBericht.Jaar"
},
"periodNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "The period number of the payroll period the record relates to",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Ulsa.LoonaangifteBericht.Periode"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period for which the tax return message was created",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period for which the tax return message was created",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"testYear": {
"type": "boolean",
"example": false,
"description": "Indicates whether the payroll periode is part of a test year.\n\nIn 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. \nPlease 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.",
"readOnly": true,
"x-loket-db-field": "af te leiden uit de jaarinrichting van de administratie Ulsa.Jaar"
}
}
},
"employments": {
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id",
"x-loket-implementation": "Loket.Dienstverband.ExternId"
},
"payrollPeriods": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payrollPeriod": {
"$ref": "#/components/schemas/payrollPeriod-2"
},
"payslipTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payslipType": {
"type": "object",
"format": "metadata",
"description": "The type of payslip on which underlying payroll run results will be booked. This is either normaal or bijzonder tarief.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Strook",
"x-loket-comment": "LET OP; hier gaat het om ulsaCode maar we willen teruggeven de loketCode (zie ctStrook)"
},
"value": {
"type": "string",
"example": "Normaal strook",
"readOnly": true,
"x-loket-db-field": "dbo.ctStrook.Omschrijving"
}
}
},
"payrollComponentResults": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payrollComponent": {
"type": "object",
"format": "metadata",
"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.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Component"
},
"value": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc. \n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Categorie"
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true,
"x-loket-db-field": "dbo.ctCategorie.omschrijving"
}
}
},
"column": {
"type": "object",
"format": "metadata",
"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.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 6,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Kolom",
"x-loket-implementation": "deze waarde kan 0 zijn met een betekenis, dus; niet vertalen naar NULL !"
},
"value": {
"type": "string",
"example": "Sociaalplichtig loon",
"readOnly": true,
"x-loket-db-field": "dbo.ctKolom.omschrijving"
}
}
},
"costsEmployer": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.KostenWerkgever"
},
"value": {
"type": "string",
"example": "+",
"readOnly": true,
"x-loket-db-field": "dbo.ctKostenWerkgever.Omschrijving"
}
}
}
}
},
"value": {
"type": "number",
"example": 40,
"description": "Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this.",
"readOnly": true,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Inhoud",
"x-loket-comment": "Maximum precision = 2"
},
"valueSpecialTariff": {
"type": "number",
"example": 144,
"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.",
"readOnly": true,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.InhoudTarief",
"x-loket-comment": "Maximum precision = 2"
}
}
}
}
}
}
}
}
}
}
}
},
"balanceSheet": {
"type": "object",
"properties": {
"payrollComponent": {
"type": "object",
"format": "metadata",
"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.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 70,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Component"
},
"description": {
"type": "string",
"example": "Wage",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
},
"balanceSheetSide": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "Indicates on what side (debit or credit) the value should go\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.journaal"
},
"value": {
"type": "string",
"example": "Credit",
"description": "The description of the side of the balance sheet\n",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctJournaal"
}
}
}
}
},
"journalAllocation": {
"type": "array",
"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.\nThe hour or factor based allocation is ignored in this endpoint.",
"minItems": 0,
"items": {
"properties": {
"generalLedgerAccount": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the general ledger account\n",
"readOnly": false
},
"generalLedgerAccountnumber": {
"type": "string",
"example": 4001,
"description": "The account number for the general ledger account\n",
"maxLength": 20,
"readOnly": true
},
"value": {
"type": "string",
"example": "Wages",
"description": "The description of the general ledger account\n",
"maxLength": 50,
"readOnly": true
}
}
},
"costCenter": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the cost center\n",
"readOnly": false
},
"value": {
"type": "string",
"example": "Sales",
"description": "The description of the cost center\n",
"maxLength": 50,
"readOnly": true
},
"code": {
"type": [
"string",
"null"
],
"example": "SAL",
"description": "The code of the cost center\n",
"maxLength": 20,
"readOnly": true
}
}
},
"costUnit": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the cost unit\n",
"readOnly": false
},
"value": {
"type": "string",
"example": "International",
"description": "The description of the cost unit\n",
"maxLength": 50,
"readOnly": true
},
"code": {
"type": [
"string",
"null"
],
"example": "INT",
"description": "The code of the cost unit\n",
"maxLength": 20,
"readOnly": true
}
}
}
}
}
},
"value": {
"type": "number",
"example": 40457.01,
"description": "The sum of all the values for the payrollcomponent in the specific payroll run. \nPayroll period, employment and normal/tarif payslip are not taken into account and simply summed up.",
"readOnly": true
}
}
},
"employeeNumber-2": {
"type": "integer",
"format": "int32",
"example": 156,
"description": "The employee number to uniquely identify a employee within a employer.",
"readOnly": true,
"x-loket-db-field": "Loket.Persoon."
},
"formattedName-2": {
"type": "string",
"example": "Wiel - van Bergen S.L. van de",
"description": "Formatted name of the employee based on the value of `howToFormatLastName`",
"maxLength": 82,
"readOnly": true,
"x-loket-implementation": "Dit veld is een samenvoegsel van de losse naam elementen. De logica voor het opbouwen van de naam is gelijk aan de logica in Loket.vwVolledigeNaam"
},
"dateOfBirth-2": {
"type": "string",
"format": "date",
"example": "1995-05-21",
"description": "The date of birth\n",
"readOnly": true
},
"startDate-9": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this employment starts.",
"readOnly": true,
"x-loket-db-field": "Loket.Dienstverband.DatumInDienst"
},
"endDate-10": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The date on which the employment ends.",
"readOnly": true,
"x-loket-db-field": "Loket.Dienstverband.DatumUitDienst"
},
"payrollResults-3": {
"type": "object",
"properties": {
"employer": {
"type": "object",
"properties": {
"employerNumber": {
"type": "integer",
"format": "int32",
"example": 20720,
"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)."
},
"companyName": {
"type": "string",
"example": "Voorbeeld B.V.",
"description": "Name of the company"
}
}
},
"payrollAdministration": {
"type": "object",
"properties": {
"clientNumber": {
"$ref": "#/components/schemas/clientNumber"
}
}
},
"employee": {
"type": "object",
"properties": {
"employeeNumber": {
"$ref": "#/components/schemas/employeeNumber-2"
},
"formattedName": {
"$ref": "#/components/schemas/formattedName-2"
},
"gender": {
"type": "string",
"example": "female",
"maxLength": 50,
"readOnly": true
},
"dateOfBirth": {
"$ref": "#/components/schemas/dateOfBirth-2"
}
}
},
"employment": {
"type": "object",
"properties": {
"startDate": {
"$ref": "#/components/schemas/startDate-9"
},
"endDate": {
"$ref": "#/components/schemas/endDate-10"
},
"payrollId": {
"type": "integer",
"format": "int32",
"example": 2,
"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.",
"readOnly": true
},
"organizationalEntity": {
"type": "object",
"properties": {
"department": {
"type": "object",
"format": "metadata",
"description": "The department of the employment.\n`department` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.Afdeling.code"
},
"description": {
"type": "string",
"example": "Verkoop",
"readOnly": true,
"x-loket-db-field": "Loket.Afdeling.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.Afdeling bevat de afdelingen voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
},
"function": {
"type": "object",
"format": "metadata",
"description": "The function of the employment.\n`function` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true
},
"description": {
"type": "string",
"example": "Directeur",
"readOnly": false,
"maxLength": 50
}
}
},
"distributionUnit": {
"type": "object",
"format": "metadata",
"description": "Distribution unit, used in several reports and the \"basic wage journal\" functionality. Commonly used as a cost center.\n",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true
},
"description": {
"type": "string",
"example": "Sales",
"readOnly": true
}
}
}
}
},
"workinghours": {
"type": "object",
"properties": {
"shift": {
"type": "object",
"properties": {
"fullTimeHoursPerWeek": {
"type": "number",
"example": 40,
"description": "The full time hours for an employment that is linked to this shift.",
"minimum": 0.01,
"maximum": 99,
"readOnly": true
}
}
},
"deviatingHoursPerWeek": {
"type": "number",
"format": "double",
"pattern": "^(\\d{1,2})(\\.\\d{1,2})?$",
"example": 32,
"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."
}
}
}
}
},
"payrollPeriod": {
"type": "object",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period the record relates to",
"example": 2017,
"readOnly": false,
"x-loket-db-field": "Ulsa.LoonaangifteBericht.Jaar"
},
"periodNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "The period number of the payroll period the record relates to",
"example": 1,
"readOnly": false
}
}
},
"payrollResults": {
"type": "object",
"properties": {
"payrollComponent": {
"type": "object",
"format": "metadata",
"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.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart.\n",
"readOnly": false
},
"value": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc. \n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true
}
}
},
"column": {
"type": "object",
"format": "metadata",
"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.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 6,
"readOnly": true
}
}
},
"costsEmployer": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true
},
"value": {
"type": "string",
"example": "+",
"readOnly": true
}
}
}
}
},
"value": {
"type": "number",
"example": 40,
"description": "Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this.",
"readOnly": true,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Inhoud",
"x-loket-comment": "Maximum precision = 2"
},
"valueSpecialTariff": {
"type": "number",
"example": 144,
"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.",
"readOnly": true,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.InhoudTarief",
"x-loket-comment": "Maximum precision = 2"
}
}
}
}
},
"provider": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"example": "Van Spaendonck Online B.V.",
"description": "Name of the provider",
"maxLength": 70,
"readOnly": false,
"x-loket-db": "dbo.Administratiekantoor.Naam"
}
}
},
"providerContactInformation": {
"type": "object",
"description": "Contact information for a given provider",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"description": "Name of the provider"
},
"contact": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"phonenumber": {
"type": "string"
},
"faxnumber": {
"type": "string"
}
}
},
"address": {
"type": "object",
"properties": {
"street": {
"type": "string",
"description": "Streetname of the address"
},
"city": {
"type": "string",
"description": "City of the address"
},
"houseNumber": {
"type": "integer",
"format": "int32",
"description": "House number of the address"
},
"houseNumberAddition": {
"type": [
"string",
"null"
],
"example": "D",
"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."
},
"furtherIndication": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"description": "The key of the further indication. Possible values can be aquired via the metadata endpoint"
},
"value": {
"type": "string",
"description": "The description of the further indication, the possible values are \"WW\" and \"AB\""
}
}
},
"postalCode": {
"type": "string",
"description": "The postal code of the address"
},
"location": {
"type": [
"string",
"null"
],
"description": "The location like to further specify the address "
},
"country": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1
},
"value": {
"type": "string",
"description": "The name of the country"
},
"isoCode": {
"type": "string",
"example": "NL"
}
}
}
}
}
}
},
"billableItemProviderObject": {
"properties": {
"providerId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"employer": {
"type": "object",
"description": "Data about the employer.\n",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"companyName": {
"type": "string",
"example": "Janssen B.V.",
"readOnly": true
},
"employerNumber": {
"type": "integer",
"format": "int32",
"example": 20720,
"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).",
"readOnly": true
},
"administrationNumber": {
"type": [
"string",
"null"
],
"example": "SR2",
"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.",
"maxLength": 15,
"readOnly": false
}
}
},
"itemType": {
"type": "object",
"description": "Details on the requested item.\n",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The item type of the billed item."
},
"description": {
"type": "string",
"example": "Preboarding traject",
"description": "The description of the item type."
}
}
},
"numberOfBillableItems": {
"type": "integer",
"format": "int32",
"example": 64,
"description": "The number of billable items for the employer and item type combination for the given time frame",
"readOnly": true
}
}
},
"dashboard-2": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"format": "uuid",
"description": "The descriptive name of the dashboard.",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"embedUrl": {
"type": "string",
"format": "url",
"example": "https://app.powerbi.com/reportEmbed?reportId=00000000-0000-0000-0000-000000000000&groupId=00000000-0000-0000-0000-000000000000&w=0&config=00000000",
"description": "The location of the provider dashboard for embedding.",
"readOnly": true
},
"embedToken": {
"type": "object",
"properties": {
"token": {
"type": "string",
"format": "url",
"example": "G4sJKSADFKJHF.........",
"description": "The accesstoken for the dashboard.",
"readOnly": true
},
"expiration": {
"type": "string",
"format": "date-time",
"example": "2024-05-08T15:16:49+02:00",
"description": "The time at which the validity of the url ends",
"readOnly": true
}
}
}
}
},
"logoObjectList": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"attribute": {
"type": "string",
"example": "Logo 1",
"description": "the attribute of the logo.",
"maxLength": 10,
"readOnly": false
},
"name": {
"type": "string",
"example": "ProviderLogo",
"description": "The name of the logo.",
"maxLength": 50,
"readOnly": false
},
"url": {
"type": "string",
"format": "url",
"example": "https://api.loket.nl/v2/v2/providers/logos/{logoId}/logo",
"description": "The url of the logo.",
"maxLength": 50,
"readOnly": false
}
}
},
"logoObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"attribute": {
"type": "string",
"example": "Logo 1",
"description": "the attribute of the logo.",
"maxLength": 10,
"readOnly": false
},
"name": {
"type": "string",
"example": "ProviderLogo",
"description": "The name of the logo.",
"maxLength": 50,
"readOnly": false
},
"data": {
"type": "string",
"example": "YQ==",
"description": "base64 encoded document file.",
"readOnly": false
},
"mimeType": {
"type": "string",
"example": "image/jpeg",
"description": "The mimetype of the data.",
"readOnly": false
}
}
},
"configurationObject-2": {
"properties": {
"defaultProviderLogo": {
"type": [
"object",
"null"
],
"description": "The default provider logo.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "Loket.VerdelingsEenheid.ExternId"
},
"attribute": {
"type": "string",
"example": "Logo 1",
"description": "the attribute of the logo.",
"maxLength": 10,
"readOnly": true
},
"name": {
"type": "string",
"example": "ProviderLogo",
"description": "The name of the logo.",
"maxLength": 50,
"readOnly": true
}
}
},
"payrollTaxReturnParty": {
"type": "object",
"readOnly": false,
"description": "Indicates the party submitting the tax return.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Loket",
"maxLength": 50,
"readOnly": true
}
}
},
"isEditNotitionAllowed": {
"type": "boolean",
"description": "This boolean value indicates whether users are allowed to edit notitions other than their own. If set to true, users can edit notitions created by other users. If set to false, users can only edit their own notitions. ",
"readOnly": false
},
"enableAutomaticDataDeletion": {
"type": "boolean",
"description": "This is a boolean value that indicates if the automatic data deletion is enabled for the administrations under the provider. If set to true, the automatic data deletion is enabled. If set to false, it is not. At administration level this setting can be overridden.",
"readOnly": false
}
}
},
"payslipConfigurationObject": {
"properties": {
"template": {
"type": [
"object"
],
"format": "metadata",
"description": "The pdf template for the payslip.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false
},
"value": {
"type": "string",
"example": "Zwart met Loket logo",
"readOnly": true
}
}
},
"addressLocation": {
"type": [
"object"
],
"format": "metadata",
"description": "The location of the address on the payslip.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false
},
"value": {
"type": "string",
"example": "Linksboven",
"readOnly": true
}
}
},
"employeeNameDisplayMethod": {
"type": [
"object"
],
"format": "metadata",
"description": "How to format the name of the employee.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false
},
"value": {
"type": "string",
"example": "Voorletters Achternaam",
"readOnly": true
}
}
},
"employeeNumberDisplayMethod": {
"type": [
"object"
],
"format": "metadata",
"description": "Choose which employeeNumber to display.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false
},
"value": {
"type": "string",
"example": "Personeelsnummer",
"readOnly": true
}
}
},
"hourlyWageDisplayMethod": {
"type": [
"object"
],
"format": "metadata",
"description": "The method to display the hourly wage on the payslip.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false
},
"value": {
"type": "string",
"example": "Uurloon",
"readOnly": true
}
}
},
"functionDisplayMethod": {
"type": [
"object"
],
"format": "metadata",
"description": "The method to display the function on the payslip.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false
},
"value": {
"type": "string",
"example": "Standaard functie",
"readOnly": true
}
}
},
"employmentStartDateDisplayMethod": {
"type": [
"object"
],
"format": "metadata",
"description": "The method to display the employment start date on the payslip.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false
},
"value": {
"type": "string",
"example": "Historical date",
"readOnly": true
}
}
},
"displaySalutation": {
"type": "boolean",
"description": "Whether to display the salutation on the payslip.",
"readOnly": false
},
"displaySalaryScale": {
"type": "boolean",
"description": "Whether to display the salary scale on the payslip.",
"readOnly": false
},
"displayDepartment": {
"type": "boolean",
"description": "Whether to display the department on the payslip.",
"readOnly": false
}
}
},
"notifications": {
"properties": {
"notificationType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The notification",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false
},
"value": {
"type": "string",
"example": "Start of employment",
"maxLength": 70,
"readOnly": true
}
}
},
"createNumberOfDaysBeforeEvent": {
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 99,
"example": 30,
"readOnly": false,
"description": "The number of days that the notification is created before the event takes place."
},
"isEnabled": {
"type": "boolean",
"description": "Enable or disable a notification for the provider",
"readOnly": false
}
}
},
"groupClassification-2": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"maxLength": 50,
"example": "Regio Zuid",
"description": "The description of the groupclassification",
"readOnly": false
}
}
},
"authorizations": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"description": {
"type": "string",
"example": "Beheren dienstverbanden",
"maxLength": 50,
"readOnly": true
},
"availableForEmployerUser": {
"type": "boolean",
"example": true,
"readOnly": true
},
"isEnabled": {
"type": "boolean",
"description": "Enable or disable an authorization",
"readOnly": false
}
}
}
},
"authorizationSets": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "HRM Rechten",
"maxLength": 50,
"readOnly": false
},
"authorizations": {
"$ref": "#/components/schemas/authorizations"
}
}
},
"modules-2": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"description": {
"type": "string",
"example": "Beheren dienstverbanden",
"readOnly": true
}
}
}
},
"moduleSets": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "HR Producten",
"readOnly": false
},
"modules": {
"$ref": "#/components/schemas/modules-2"
}
}
},
"moduleSetPatch": {
"properties": {
"description": {
"type": "string",
"example": "HR Producten",
"readOnly": false
},
"modules": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of the module\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"action": {
"type": "string",
"enum": [
"enable",
"disable"
],
"description": "The action to perform.",
"readOnly": false
}
}
}
}
}
},
"moduleSetEmployer": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "HR Producten",
"readOnly": true
}
}
},
"idNullableEditable": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"moduleSetEmployerPut": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/idNullableEditable"
}
}
},
"notifications-2": {
"type": "array",
"items": {
"properties": {
"notificationType": {
"type": "object",
"format": "metadata",
"description": "The notification set",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false
},
"value": {
"type": "string",
"example": "Start of employment",
"maxLength": 70,
"readOnly": true
}
}
},
"createNumberOfDaysBeforeEvent": {
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 99,
"example": 30,
"readOnly": false,
"description": "The number of days that the notification is created befor the event takes place."
},
"sendMailWhenNotificationIsCreated": {
"type": "boolean",
"example": false,
"readOnly": false,
"description": "send an email when on creation of the notification"
},
"receiveDepartmentSignalsOnly": {
"type": "boolean",
"example": false,
"readOnly": false,
"description": "Only receive notification for your departments.\nNot relevant if the user is not a department manager."
},
"isEnabled": {
"type": "boolean",
"description": "Enable or disable a notification for a user",
"readOnly": false
}
}
}
},
"notificationSets": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Salarisadministrateur",
"maxLength": 50,
"readOnly": false
},
"numberOfLinkedEmployerUsers": {
"type": "integer",
"format": "int32",
"example": 435,
"description": "The number of employer users that are linked to this notification set",
"readOnly": true
},
"notifications": {
"$ref": "#/components/schemas/notifications-2"
}
}
},
"notificationSetPatch": {
"properties": {
"description": {
"type": "string",
"example": "HR Signalen",
"readOnly": false,
"maxLength": 50
},
"notifications": {
"$ref": "#/components/schemas/notifications-2"
}
}
},
"payrollAdministrationVeldenTBVHergebruik": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"employerLogo": {
"type": [
"string",
"null"
],
"format": "url",
"example": "https://api.loket.nl/v2/v2/providers/employers/{guid}/logo/{version}",
"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.",
"readOnly": true
},
"employerId": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"example": "VST Consultancy",
"description": "Name of the administration",
"maxLength": 70
},
"administrationNumber": {
"type": [
"string",
"null"
],
"example": "134.26.94",
"description": "The administration number is a free field commonly used to register the debtors number.",
"maxLength": 15
},
"description": {
"type": "string",
"example": "VST Consultancy",
"description": "The description is used to identify the administration in Loket at Employerlevel.",
"x-loket-db-field": "Loket.Verloning.Omschrijving"
},
"clientNumber": {
"type": "integer",
"format": "int32",
"example": 465,
"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."
},
"payrollPeriodType": {
"type": "object",
"format": "metadata",
"readOnly": true,
"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).",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.code"
},
"value": {
"type": "string",
"example": "month",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.omschrijving"
}
}
},
"hasAutomaticPayroll": {
"type": "boolean",
"description": "Indicates whether automatic payrolling is set",
"readOnly": true
},
"cao": {
"type": "object",
"format": "metadata",
"description": "The CAO (CLA -> collective labor agrement) of the \"loonmodel\" the payroll administration is linked to.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 115,
"readOnly": false
},
"value": {
"type": "string",
"example": "18 Vishandel",
"maxLength": 50,
"readOnly": true
}
}
},
"loonmodel": {
"type": "object",
"format": "metadata",
"description": "The \"loonmodel\" (this is a Loket term) the payroll administration inherits the payrolling configuration from. Deviating from the loonmodel configuration on payrol administration level is possible.\n\n`loonmodel` is a metadata field within the provider context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 929
},
"value": {
"type": "string",
"example": "Vishandel monthly payrolling",
"maxLength": 50
}
}
},
"groupClassification": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The group classification for the payroll administration. This field is used for filtering and grouping within the interface.\n\n`groupClassification` is a metadata field within the provider context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false
},
"value": {
"type": "string",
"example": "South",
"readOnly": true
}
}
},
"groupCode": {
"type": [
"integer",
"null"
],
"format": "metadata",
"description": "Number (integer) used for grouping administrations.",
"example": 40,
"readOnly": false
},
"HasPayrollRunStatusOpen": {
"type": "boolean",
"description": "Indicates whether the administration has an open payrolrun",
"readOnly": true
}
}
},
"payrollStatus": {
"allOf": [
{
"$ref": "#/components/schemas/payrollAdministrationVeldenTBVHergebruik"
},
{
"properties": {
"shortName": {
"type": [
"string",
"null"
],
"example": "VST",
"description": "Shortened name of the administration"
},
"payrollPeriod": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period\n",
"example": 2020,
"readOnly": true
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53])\n",
"example": 4,
"readOnly": true
},
"payrollPeriodId": {
"type": "integer",
"format": "int32",
"description": "The year and period of the payroll period\n",
"example": 202004,
"readOnly": true
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period to which the payroll period data applies\n",
"example": "2020-04-01",
"readOnly": true
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period to which the payroll period data applies\n",
"example": "2020-06-30",
"readOnly": true
}
}
},
"payroll": {
"type": "object",
"readOnly": true,
"properties": {
"methodOfCreation": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The key indicating how the payroll run was created.",
"readOnly": true,
"x-loket-db-field": "Ulsa.VerloningsRun.WijzeVanAanmaak",
"x-loket-implementation": "In de database kan dit veld null zijn maar omdat de default waarde 0 is, zal dit nooit het geval zijn. In de API kiezen we er dus voor om dit veld niet nullable te maken."
},
"value": {
"type": "string",
"example": "Individueel",
"description": "The value describing how the payroll run was created.",
"readOnly": true,
"x-loket-db-field": "dbo.ctWijzeVanAanmaak.Omschrijving"
}
}
},
"automaticStartDate": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The set day on which the payroll is automatically started.\n",
"example": "2025-01-18",
"readOnly": true
},
"automaticApproveDate": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The set day on which the payroll is automatically approved.\n",
"example": "2025-01-25",
"readOnly": true
},
"status": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "Status of the payroll process in the period.\nPossible statuses are:\n- 0\tInvalid\n- 1\tNot started\n- 2\tQueued\n- 3\tWaiting for approval\n- 4\tIncorrect and there is an approved preceding payrollrun\n- 5\tIncorrect\n- 6\tApproved \n- 7\tNo results\n- 8\tNo results and there is an approved preceding payrollrun\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 6,
"readOnly": true
},
"value": {
"type": "string",
"example": "geannuleerde loonrun",
"readOnly": true
}
}
},
"possibleActions": {
"type": "object",
"readOnly": true,
"description": "Possible actions for the payroll process in the period.\nPossible actions are:\n- 0\tNone (no action possible)\n- 1\tReady to proces\n- 2\tStart\n- 3\tRestart\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": true
},
"value": {
"type": "string",
"example": "None",
"readOnly": true
}
}
},
"userRights": {
"type": "object",
"readOnly": true,
"properties": {
"hasStartRight": {
"type": "boolean",
"description": "indicates whether the current user has the right for this administration.",
"readOnly": true
},
"hasCalculateWorkingHoursRight": {
"type": "boolean",
"description": "indicates whether the current user has the right for this administration.",
"readOnly": true
},
"hasCancelRight": {
"type": "boolean",
"description": "indicates whether the current user has the right for this administration.",
"readOnly": true
},
"hasConfirmRight": {
"type": "boolean",
"description": "indicates whether the current user has the right for this administration.",
"readOnly": true
}
}
}
}
},
"numberOfUnreadNotifications": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "Indicates the amount of unread notifications"
},
"numberOfUnreadUnexpiredAnnouncements": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "Indicates the amount of unread announcements"
}
}
}
]
},
"payrollTaxReturnStatus": {
"allOf": [
{
"$ref": "#/components/schemas/payrollAdministrationVeldenTBVHergebruik"
},
{
"properties": {
"payrollPeriod": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period\n",
"example": 2020,
"readOnly": true
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53])\n",
"example": 4,
"readOnly": true
},
"payrollPeriodId": {
"type": "integer",
"format": "int32",
"description": "The year and period of the payroll period\n",
"example": 202004,
"readOnly": true
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period to which the payroll period data applies\n",
"example": "2020-04-01",
"readOnly": true
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period to which the payroll period data applies\n",
"example": "2020-06-30",
"readOnly": true
}
}
},
"shortName": {
"type": [
"string",
"null"
],
"example": "VST",
"description": "Shortened name of the administration",
"maxLength": 12,
"x-loket-db-field": "Ulsa.Werkgever.KorteNaam"
},
"wageTaxNumber": {
"type": "string",
"description": "The wage tax number aka Loonheffingennummer.",
"maxLength": 12,
"example": "111111110L00",
"readOnly": true
},
"payrollTaxReturnParty": {
"type": "object",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key indicating who is responsible for handling the payroll tax return.",
"readOnly": true
},
"value": {
"type": "string",
"example": "Loket",
"description": "The value describing who is responsible for handling the payroll tax return.",
"readOnly": true
}
}
},
"payrollTaxReturn": {
"type": "object",
"readOnly": true,
"properties": {
"methodOfCreation": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The key indicating how the paytaxreturn was created.",
"readOnly": true
},
"value": {
"type": "string",
"example": "Individueel",
"description": "The value describing how the paytaxreturn was created.",
"readOnly": true
}
}
},
"automaticStartDate": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The set day on which the payrolltaxreturn is automatically started.\n",
"example": "2025-01-18",
"readOnly": true
},
"automaticApproveDate": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The set day on which the payrolltaxreturn is automatically approved.\n",
"example": "2025-01-25",
"readOnly": true
},
"processingFinishedTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2021-05-08T15:16:49+02:00",
"description": "Date-time when the calculations were finished",
"readOnly": true
},
"approvalTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2021-05-08T15:16:49+02:00",
"description": "The time at which the payroll tax return run was approved by the user",
"readOnly": true
},
"approvedBy": {
"$ref": "#/components/schemas/userBasic"
},
"status": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "Status of the payrollTaxReturn in the period.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 6,
"readOnly": true
},
"value": {
"type": "string",
"example": "Approved",
"readOnly": true
}
}
},
"possibleActions": {
"type": "object",
"readOnly": true,
"description": "Possible actions for the upa pension declaration in the period.\nPossible actions are:\n- 0\tNone (no action possible)\n- 1\tStart\n- 2\tProcess\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": true
},
"value": {
"type": "string",
"example": "None",
"readOnly": true
}
}
},
"userRights": {
"type": "object",
"readOnly": true,
"properties": {
"hasStartRight": {
"type": "boolean",
"description": "Indicates whether the current user has the right for this administration.",
"readOnly": true
},
"hasConfirmRight": {
"type": "boolean",
"description": "Indicates whether the current user has the right for this administration.",
"readOnly": true
}
}
}
}
}
}
}
]
},
"pensionDeclarationStatus": {
"allOf": [
{
"$ref": "#/components/schemas/payrollAdministrationVeldenTBVHergebruik"
},
{
"properties": {
"payrollPeriod": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period\n",
"example": 2020,
"readOnly": true
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53])\n",
"example": 4,
"readOnly": true
},
"payrollPeriodId": {
"type": "integer",
"format": "int32",
"description": "The year and period of the payroll period\n",
"example": 202004,
"readOnly": true
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period to which the payroll period data applies\n",
"example": "2020-04-01",
"readOnly": true
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period to which the payroll period data applies\n",
"example": "2020-06-30",
"readOnly": true
}
}
},
"wageTaxNumber": {
"type": [
"string",
"null"
],
"description": "The wage tax number aka Loonheffingennummer.",
"maxLength": 12,
"example": "111111110L00",
"readOnly": true
},
"automaticStartDate": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The set day on which the pensiondeclaration is automatically started.\n",
"example": "2025-01-18",
"readOnly": true
},
"automaticApproveDate": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The set day on which the pensiondeclaration is automatically approved.\n",
"example": "2025-01-25",
"readOnly": true
},
"pensionDeclaration": {
"type": "object",
"readOnly": true,
"properties": {
"customerGroupNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "The customer group number aka Klantgroepnummer.",
"example": 123456,
"readOnly": true
},
"externalParty": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The external party the pension declaration is sent to.",
"readOnly": true
},
"value": {
"type": "string",
"example": "PFZW (UPA)",
"description": "The external party the pension declaration is sent to.",
"readOnly": true
}
}
},
"pensionAdministratorType": {
"type": "string",
"enum": [
"UPA",
"APG"
],
"description": "The type of Pension declaration",
"readOnly": false
},
"methodOfCreation": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The key indicating how the pension declaration was created.",
"readOnly": true
},
"value": {
"type": "string",
"example": "Individueel",
"description": "The value describing how the pension declaration was created.",
"readOnly": true
}
}
},
"status": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "Status in the period.\nPossible statuses are:\n- 0\tInvalid\n- 1\tNot started\n- 2\tQueued\n- 3\tWaiting for approval\n- 5\tIncorrect\n- 6\tApproved\n- 9\tApproved and sent\n- 10\tNot available\n- 11\tCancelled\n- 12\tDeleted\n- 13\tBlank\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 6,
"readOnly": true
},
"value": {
"type": "string",
"example": "Approved",
"readOnly": true
}
}
},
"possibleActions": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "Possible actions in the period.\nPossible actions are:\n- 0\tNone (no action possible)\n- 1\tReady to proces\n- 2\tStart\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": true
},
"value": {
"type": "string",
"example": "None",
"readOnly": true
}
}
},
"userRights": {
"type": "object",
"readOnly": true,
"properties": {
"hasStartRight": {
"type": "boolean",
"description": "Indicates whether the current user has the right for this administration.",
"readOnly": true
},
"hasConfirmRight": {
"type": "boolean",
"description": "Indicates whether the current user has the right for this administration.",
"readOnly": true
}
}
}
}
}
}
}
]
},
"yearStatus": {
"allOf": [
{
"$ref": "#/components/schemas/payrollAdministrationVeldenTBVHergebruik"
},
{
"properties": {
"testYear": {
"type": "boolean",
"example": false,
"description": "Indicates whether the payroll periode is part of a test year.",
"readOnly": true
},
"externalParty": {
"type": "object",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the external (APG) party.",
"readOnly": true
},
"value": {
"type": "string",
"example": "APG-bouw",
"description": "The value describing the external (APG) party.",
"readOnly": true
}
}
},
"year": {
"type": "object",
"readOnly": true,
"properties": {
"yearId": {
"$ref": "#/components/schemas/id"
},
"status": {
"type": "object",
"readOnly": true,
"description": "Status of the year.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": true
},
"value": {
"type": "string",
"example": "Active",
"readOnly": true
}
}
},
"possibleActions": {
"type": "object",
"readOnly": true,
"description": "Possible actions for the payroll process in the period.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": true
},
"value": {
"type": "string",
"example": "None",
"readOnly": true
},
"additionalInformation": {
"type": "object",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true
},
"value": {
"type": "string",
"example": "The year already has been closed.",
"description": "The additional information on the possible action.",
"readOnly": true
}
}
}
}
},
"userRights": {
"type": "object",
"readOnly": true,
"properties": {
"hasRequestTranstionRight": {
"type": "boolean",
"description": "Indicates whether the current user has the right to request a year transition.",
"readOnly": true
}
}
}
}
},
"payroll": {
"type": "object",
"readOnly": true,
"description": "Information on the payrollproces of the selected year.\n",
"properties": {
"lastPeriodNumberWithApprovedPayrollRun": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 8,
"readOnly": true,
"description": "The last period with an approved payroll run in the selected year.\n"
}
}
}
}
}
]
},
"journalRun": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id",
"x-loket-db-field": "Ulsa.JournaalRun"
},
"sequenceNumber": {
"type": "integer",
"format": "int32",
"description": "Ascending sequence number over ALL journal runs for the payroll administration.",
"example": 8,
"readOnly": true,
"x-loket-db-field": "Ulsa.JournaalRun.Volgnummer"
},
"payrollRun": {
"type": "object",
"properties": {
"payrollRunId": {
"$ref": "#/components/schemas/id"
},
"payrollPeriod": {
"$ref": "#/components/schemas/payrollPeriod-2"
},
"sequenceNumberApproved": {
"type": "integer",
"format": "int32",
"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. ",
"readOnly": true,
"example": 6,
"x-loket-db-field": "Waarde van VolgnummerVerloningsrun moet omgezet worden naar de waarde van VolgnummerGoedgekeurd in de Verloningsrun tabel!!!!"
}
}
},
"journalRunStatus": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 4,
"description": "Possible values for the payroll run status are;\n\n* 0\tStaat klaar voor journaliseren\n* 1\tGeen journaal resultaten\n* 2\tFout bij aanmaken\n* 3\tVerwijderd door gebruiker\n* 4\tJournaal gereed\n* 5\tWordt geëxporteerd\n* 6\tExporteren mislukt\n* 7\tJournaal geëxporteerd\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.JournaalRun.Status"
},
"value": {
"type": "string",
"example": "Journaal gereed",
"description": "The value describing the current status of the payroll run.",
"readOnly": true,
"x-loket-db-field": "dbo.ctStatusJournaalRun.Omschrijving"
}
}
},
"requestTime": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the payroll run was requested by the user",
"readOnly": true,
"x-loket-db-field": "Ulsa.JournaalRun.DatumTijdOpdracht"
},
"processingFinishedTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which at which the journal run was finished processing",
"readOnly": true,
"x-loket-db-field": "Ulsa.JournaalRun.DatumTijdGereed"
},
"requestedBy": {
"$ref": "#/components/schemas/userBasicNotNullable"
},
"removeTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The time at which the journal run was removed.",
"example": "2018-05-08T15:16:49+02:00",
"readOnly": true,
"x-loket-db-field": "Ulsa.JournaalRun.DatumVerwijderd"
},
"removedBy": {
"$ref": "#/components/schemas/userBasic"
},
"methodOfCreation": {
"type": "object",
"format": "metadata",
"description": "Method by which the creation of the journal run was triggered.",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Ulsa.JournaalRun.WijzeAanmaak",
"x-loket-implementation": "In de database kan dit veld null zijn maar omdat de default waarde 0 is, zal dit nooit het geval zijn. In de API kiezen we er dus voor om dit veld niet nullable te maken."
},
"value": {
"type": "string",
"example": "Individueel",
"readOnly": true,
"x-loket-db-field": "dbo.ctWijzeVanAanmaak.Omschrijving"
}
}
}
}
},
"journalrunStatusPatch": {
"properties": {
"action": {
"type": "string",
"x-loket-implementation1": "alleen uit te voeren indien status = 4, 5, 6 of 7",
"enum": [
"MarkAsProcessed",
"MarkAsProcessingFailed"
],
"description": "The action to perform on the journal run\n* MarkAsProcessed --> (from the Loket point of view) Indicates that the client successfully processed the data (indicating that the results were imported in the financial application).\n* MarkAsProcessingFailed --> (from the Loket point of view) Indicates that the client was unable to process the results. Use the `message` field to communicate the error(s).",
"readOnly": false
},
"application": {
"type": "object",
"format": "metadata",
"description": "The application that downloaded and processed the results",
"readOnly": false,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Ulsa.JournaalRun.ApplicatieID"
},
"value": {
"type": "string",
"example": "Financieel pakket 1",
"readOnly": true,
"x-loket-db-field": "dbo.ctJournaalApplicatie.Omschrijving"
}
}
},
"message": {
"type": [
"string",
"null"
],
"description": "Message to be displayed to the Loket user",
"readOnly": false,
"maxLength": 255
}
}
},
"journalRunResults": {
"x-loket-comment": "er is een storedProcedure die gegevens uit Ulsa.WerknemerJournaalResultaat reeds groepeert = [Ulsa].[prcGeefJournaliseringRun]. Of deze ook echt gebruikt dient te worden is een tweede.",
"x-loket-comment1": "Indien de inrichting van een grootboekrekening op Verdichten 'Nee' staat; dan in de output de grootboekrekeningregel splitsen per Loket-component. Anders; groeperen op één grootboekrekeningregel.",
"x-loket-comment2": "Indien de inrichting van een grootboekrekening op Kostenrekening op 'Ja' staat; dan in de output de groetboekrekeningregel uitsplitsen per unieke combinatie {groetboeknr, kostenplaats, kostendrager}. Anders; groeperen op één grootboekrekeningregel.",
"type": "object",
"properties": {
"generalLedgerAccount": {
"type": "object",
"format": "metadata",
"description": "General ledger account number and description\n\n`generalLedgerAccount` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 4,
"readOnly": true,
"description": "Database id (unique per administration).",
"x-loket-db-field": "Ulsa.WerknemerJournaalResultaat.GrootboekrekeningId",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. en code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "4002020",
"readOnly": true,
"description": "The general ledger accounting number (grootboekrekeningnummer)",
"x-loket-db-field": "Ulsa.Grootboek.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Cars",
"readOnly": true,
"description": "Description for the general ledger accounting number.",
"x-loket-db-field": "Ulsa.Grootboek.Naam",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"costCenter": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost center on which the data for this entry will be booked for the ledger.\n\n`costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-implementation": "null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.WerknemerJournaalResultaat.KostenplaatsID",
"x-loket-implementation": "Kan geen GUID zijn vanwege de overerving. De code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "SAL073",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Sales Den Bosch",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"costUnit": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost unit on which the data for this entry will be booked for the ledger.\n\n`costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-implementation": "null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.WerknemerJournaalResultaat.KostenDragerID",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. en code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "01",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Cars",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"payrollComponent": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-comment": "Indien niet van toepassing; payrollComponent-object NULL",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 286,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know it by heart.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Component"
},
"description": {
"type": "string",
"example": "KINDEROPV.BEL",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
}
}
},
"debetAmount": {
"x-loket-comment1": "Indien er voor het berekenen van een regel zowel debet als credet waarden zijn;\tdan in de output; deze waarden worden tegen elkaar weggestreept en worden uiteindelijk als één positief getal weergeven aan debet OF credet kant",
"x-loket-comment2": "Het is dus niet mogelijk om op een regel zowel een credet als debet bedrag te hebben (>0)",
"x-loket-comment3": "Een negatief getal is ook niet mogelijk; dit zou een positief getal moeten zijn aan dan wel credet of debet kant",
"type": "number",
"example": 500.87,
"description": "The debet amount for the ledger entry.\n",
"x-loket-implementation": "Indien DebetCredit =1 1 dan bedrag is Debet. Maximum precision = 2",
"readOnly": true
},
"creditAmount": {
"type": "number",
"example": 0,
"description": "The credit amount for the ledger entry.\n",
"x-loket-implementation": "Indien DebetCredit =2 dan bedrag is Credit. Maximum precision = 2",
"readOnly": true
}
}
},
"journalRunCumulativeResults": {
"x-loket-comment": "er is een storedProcedure die gegevens uit Ulsa.WerknemerJournaalResultaat reeds groepeert = [Ulsa].[prcGeefJournaliseringRun]. Of deze ook echt gebruikt dient te worden is een tweede.",
"x-loket-comment1": "Indien de inrichting van een grootboekrekening op Verdichten 'Nee' staat; dan in de output de grootboekrekeningregel splitsen per Loket-component. Anders; groeperen op één grootboekrekeningregel.",
"x-loket-comment2": "Indien de inrichting van een grootboekrekening op Kostenrekening op 'Ja' staat; dan in de output de groetboekrekeningregel uitsplitsen per unieke combinatie {groetboeknr, kostenplaats, kostendrager}. Anders; groeperen op één grootboekrekeningregel.",
"type": "object",
"properties": {
"payrollPeriodStart": {
"type": "number",
"example": 202501,
"description": "The first payroll period in the dataset which contains journal results.\n",
"readOnly": true
},
"payrollPeriodEnd": {
"type": "number",
"example": 202501,
"description": "The last payroll period in the dataset which contains journal results.\n",
"readOnly": true
},
"generalLedgerAccount": {
"type": "object",
"format": "metadata",
"description": "General ledger account number and description\n\n`generalLedgerAccount` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 4,
"readOnly": true,
"description": "Database id (unique per administration).",
"x-loket-db-field": "Ulsa.WerknemerJournaalResultaat.GrootboekrekeningId",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. en code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "4002020",
"readOnly": true,
"description": "The general ledger accounting number (grootboekrekeningnummer)",
"x-loket-db-field": "Ulsa.Grootboek.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Cars",
"readOnly": true,
"description": "Description for the general ledger accounting number.",
"x-loket-db-field": "Ulsa.Grootboek.Naam",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"costCenter": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost center on which the data for this entry will be booked for the ledger.\n\n`costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-implementation": "null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.WerknemerJournaalResultaat.KostenplaatsID",
"x-loket-implementation": "Kan geen GUID zijn vanwege de overerving. De code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "SAL073",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Sales Den Bosch",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"costUnit": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost unit on which the data for this entry will be booked for the ledger.\n\n`costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-implementation": "null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.WerknemerJournaalResultaat.KostenDragerID",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. en code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "01",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Cars",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"payrollComponent": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-comment": "Indien niet van toepassing; payrollComponent-object NULL",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 286,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know it by heart.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Component"
},
"description": {
"type": "string",
"example": "KINDEROPV.BEL",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
}
}
},
"debetAmount": {
"x-loket-comment1": "Indien er voor het berekenen van een regel zowel debet als credet waarden zijn;\tdan in de output; deze waarden worden tegen elkaar weggestreept en worden uiteindelijk als één positief getal weergeven aan debet OF credet kant",
"x-loket-comment2": "Het is dus niet mogelijk om op een regel zowel een credet als debet bedrag te hebben (>0)",
"x-loket-comment3": "Een negatief getal is ook niet mogelijk; dit zou een positief getal moeten zijn aan dan wel credet of debet kant",
"type": "number",
"example": 500.87,
"description": "The debet amount for the ledger entry.\n",
"x-loket-implementation": "Indien DebetCredit =1 1 dan bedrag is Debet. Maximum precision = 2",
"readOnly": true
},
"creditAmount": {
"type": "number",
"example": 0,
"description": "The credit amount for the ledger entry.\n",
"x-loket-implementation": "Indien DebetCredit =2 dan bedrag is Credit. Maximum precision = 2",
"readOnly": true
}
}
},
"sequenceNumber": {
"type": "integer",
"format": "int32",
"description": "Ascending sequence number over ALL journal runs within a yearfor the payroll administration.",
"example": 8,
"readOnly": true
},
"exportedOn": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the export was started",
"readOnly": true
},
"exportedTo": {
"type": "object",
"format": "metadata",
"description": "The (financial) application to which the journal results where send",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true
},
"value": {
"type": "string",
"example": "Finance Plus",
"readOnly": true
}
}
},
"methodOfExporting": {
"type": "object",
"format": "metadata",
"description": "The ways by which the journal results where exported (download/API call)",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true
},
"value": {
"type": "string",
"example": "Download",
"readOnly": true
}
}
},
"exportStatus": {
"type": "object",
"format": "metadata",
"description": "The status of the export",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 4,
"description": "The status of the export (successful or failed) \n",
"readOnly": true
},
"value": {
"type": "string",
"example": "Downloaded",
"description": "The value describing the current status of the payroll run.",
"readOnly": true
}
}
},
"returendErrorMessage": {
"type": [
"string",
"null"
],
"example": "Could not find cost center Sales",
"description": "Incase the export (by means of an API) failed the returned errors are provided here.",
"readOnly": true,
"maxLength": 4000
},
"journalRunExportAuditTrail": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"sequenceNumber": {
"$ref": "#/components/schemas/sequenceNumber"
},
"exportedOn": {
"$ref": "#/components/schemas/exportedOn"
},
"exportedBy": {
"$ref": "#/components/schemas/userBasicNotNullable"
},
"exportedTo": {
"$ref": "#/components/schemas/exportedTo"
},
"methodOfExporting": {
"$ref": "#/components/schemas/methodOfExporting"
},
"exportStatus": {
"$ref": "#/components/schemas/exportStatus"
},
"returendErrorMessage": {
"$ref": "#/components/schemas/returendErrorMessage"
}
}
},
"journalRunError": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"error": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 4,
"description": "The error code",
"readOnly": true
},
"value": {
"type": "string",
"example": "Geen verdeling gevonden voor de component, kostenplaats, kostendrager combinatie",
"description": "The description of the error",
"readOnly": true
}
}
},
"PayrollEmployeeNumber": {
"type": "integer",
"format": "int32",
"example": 202,
"description": "The number of the employment in relation to the payroll administration.",
"readOnly": true
},
"generalLedgerAccount": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "General ledger account number and description\n\n`generalLedgerAccount` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 4,
"readOnly": true,
"description": "Database id (unique per administration).",
"x-loket-db-field": "Ulsa.WerknemerJournaalResultaat.GrootboekrekeningId",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. en code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "4002020",
"readOnly": true,
"description": "The general ledger accounting number (grootboekrekeningnummer)",
"x-loket-db-field": "Ulsa.Grootboek.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Cars",
"readOnly": true,
"description": "Description for the general ledger accounting number.",
"x-loket-db-field": "Ulsa.Grootboek.Naam",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"costCenter": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost center on which the data for this entry will be booked for the ledger.\n\n`costCenter` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-implementation": "null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.WerknemerJournaalResultaat.KostenplaatsID",
"x-loket-implementation": "Kan geen GUID zijn vanwege de overerving. De code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "SAL073",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Sales Den Bosch",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"costUnit": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost unit on which the data for this entry will be booked for the ledger.\n\n`costUnit` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-implementation": "null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.WerknemerJournaalResultaat.KostenDragerID",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. en code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "01",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Cars",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"payrollComponent": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"x-loket-comment": "Indien niet van toepassing; payrollComponent-object NULL",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 286,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know it by heart.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Component"
},
"description": {
"type": "string",
"example": "KINDEROPV.BEL",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
}
}
}
}
},
"journalrunExportSend": {
"properties": {
"date": {
"type": "string",
"format": "date",
"example": "2022-01-01",
"description": "Date",
"readOnly": false
},
"journalNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 2,
"readOnly": false
},
"period": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 2,
"description": "the period to which the journal should be added.",
"readOnly": false
},
"financialYear": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 2023,
"readOnly": false
},
"description": {
"type": [
"string",
"null"
],
"example": "Opmerking 1",
"readOnly": false
},
"administration": {
"type": [
"object",
"null"
],
"description": "The administration in the journalapplication to which the journal will be added.",
"readOnly": false,
"properties": {
"id": {
"type": "integer",
"format": "int32",
"example": 223,
"readOnly": false
},
"value": {
"type": [
"string",
"null"
],
"example": "Administration A",
"readOnly": true
}
}
},
"subAdministration": {
"type": [
"object",
"null"
],
"description": "The subadministration in the journalapplication to which the journal will be added.",
"readOnly": false,
"properties": {
"Id": {
"type": "integer",
"format": "int32",
"example": 223,
"readOnly": false
},
"Name": {
"type": "string",
"example": "Administration A",
"readOnly": true
}
}
},
"user": {
"type": [
"string",
"null"
],
"example": "User1",
"readOnly": true
},
"journalCode": {
"type": [
"string",
"null"
],
"example": "2",
"readOnly": false
},
"includeCostCenter": {
"type": [
"boolean",
"null"
],
"example": true,
"description": "Indicates whether cost centers are included in the journal.",
"readOnly": false
},
"includeCostUnit": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Indicates whether cost units are included in the journal.",
"readOnly": false
},
"account": {
"type": [
"object",
"null"
],
"description": "The account to connect to the journal application.",
"readOnly": false,
"properties": {
"id": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false
},
"value": {
"type": "string",
"example": "Account Jan",
"readOnly": true
}
}
},
"accountKey": {
"type": [
"string",
"null"
],
"example": "User1",
"readOnly": false
},
"deviatingJournalSeries": {
"type": [
"string",
"null"
],
"example": "Afwijking1",
"readOnly": false
},
"linkCostCenterToGroup": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "The Group to which the CostCenter will be linked.\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"linkCostUnitToGroup": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "The Group to which the CostUnit will be linked.\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"suspenseAccount": {
"type": [
"string",
"null"
],
"example": "SAL-4000",
"description": "The \"number\" for the suspense account (is a string)",
"minLength": 1,
"maxLength": 20,
"readOnly": false
}
}
},
"journalrunExportDownload": {
"properties": {
"date": {
"type": "string",
"format": "date",
"example": "2022-01-01",
"description": "Date",
"readOnly": false
},
"includeCostCenter": {
"type": "boolean",
"example": true,
"description": "Indicates whether cost centers are included in the journal.",
"readOnly": false
},
"includeCostUnit": {
"type": "boolean",
"example": false,
"description": "Indicates whether cost units are included in the journal.",
"readOnly": false
},
"suspenseAccount": {
"type": [
"string",
"null"
],
"example": "SAL-4000",
"description": "The \"number\" for the suspense account (is a string)",
"minLength": 1,
"maxLength": 20,
"readOnly": false
}
}
},
"journalConfigurationObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"journalProfile": {
"type": "object",
"format": "metadata",
"readOnly": false,
"properties": {
"id": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true
},
"description": {
"type": "string",
"example": "General ledger supermarkets",
"readOnly": true
}
}
},
"startPeriod": {
"$ref": "#/components/schemas/startPeriod"
},
"endPeriod": {
"$ref": "#/components/schemas/endPeriod"
},
"automaticallyInitiateJournalRun": {
"type": "boolean",
"example": false,
"description": "Indicates whether a journal run is automaticly started when a payroll run is approved",
"readOnly": false
}
}
},
"journalApplicationPut": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "The journal application (financial software for the general ledger). This field indicates how what export options are available by a journal run (as supported by the given application) and as such dictates the format of the export/download.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of journal application",
"readOnly": false
},
"value": {
"type": "string",
"example": "Precies Online",
"description": "Name of the journal application",
"maxLength": 50,
"readOnly": true
}
}
},
"financialAdministration": {
"type": [
"object",
"null"
],
"description": "The financial administration",
"format": "metadata",
"properties": {
"code": {
"type": "string",
"example": "NL-12345",
"minLength": 1,
"maxLength": 255,
"description": "The key of the financial administration",
"readOnly": false
},
"externalValue": {
"type": [
"string",
"null"
],
"example": "Vesting Den Helder",
"description": "Name of the financial administration. This field is only set when a connection with an external API exists (via `account`) to aquire the name from.",
"maxLength": 255,
"readOnly": true
}
}
},
"journalCode": {
"type": [
"string",
"null"
],
"example": "2",
"maxLength": 255,
"readOnly": false,
"description": "DagboekCode"
},
"account": {
"type": [
"object",
"null"
],
"description": "The account to connect to the financial software.",
"readOnly": false,
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false
},
"value": {
"type": "string",
"example": "Account Jan",
"maxLength": 250,
"readOnly": true
}
}
},
"description-5": {
"type": [
"string",
"null"
],
"example": "General ledger supermarkets",
"description": "The description to be send in with the ledger lines",
"maxLength": 255,
"readOnly": false
},
"isAutomatedExportEnabled": {
"type": [
"boolean",
"null"
],
"example": false,
"readOnly": false,
"description": "This field indicates whether journalruns will be exported automaticaly or not"
},
"methodForDeterminingAccountingPeriod": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": false,
"description": "This field indicates how the system should determine the (financial)period to book the results on.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of accounting period determination method",
"readOnly": false
},
"value": {
"type": "string",
"example": "Periode eerste dag verloningsperiode",
"description": "description of the method\n\nWhen \"Op basis van schema\" is used `payrollPeriodFinancialPeriodMapping` must have a value. \nNote that not all applications support \"Op basis van schema\"",
"maxLength": 50,
"readOnly": true
}
}
},
"deviatingJournalSeries": {
"type": [
"string",
"null"
],
"pattern": "^[a-zA-Z]$",
"example": "A",
"description": "Afwijking boekstuk serie",
"maxLength": 1,
"readOnly": false
},
"linkCostCenterToGroup": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "links the cost center to a group",
"properties": {
"code": {
"type": "string",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The code of the group",
"readOnly": false
},
"externalValue": {
"type": [
"string",
"null"
],
"example": "Vesting Den Helder",
"description": "Name of the group. This field is only set when a connection with an external API exists (via `account`) to aquire the name from.",
"maxLength": 255,
"readOnly": true
}
}
},
"linkCostUnitToGroup": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "links the cost unit to a group",
"properties": {
"code": {
"type": "string",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The code of the group",
"readOnly": false
},
"externalValue": {
"type": [
"string",
"null"
],
"example": "Vesting Den Helder",
"description": "Name of the group. This field is only set when a connection with an external API exists (via `account`) to aquire the name from.",
"maxLength": 255,
"readOnly": true
}
}
},
"includeCostCenter": {
"type": [
"boolean",
"null"
],
"example": true,
"description": "Indicates whether cost centers are included in the journal export",
"readOnly": false
},
"includeCostUnit": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Indicates whether cost units are included in the journal export",
"readOnly": false
},
"payrollPeriodFinancialPeriodMapping": {
"type": [
"array",
"null"
],
"description": "This mapping should be used when the payroll year and the financial years dont match. As is the case when a financial year starts in the 3th month.",
"items": {
"properties": {
"payrollPeriodNumber": {
"type": "integer",
"format": "int32",
"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.\n",
"example": 1,
"minimum": 1,
"maximum": 53,
"readOnly": false
},
"financialPeriodNumber": {
"type": "integer",
"format": "int32",
"description": "The period of the financial year in which the ledger data is to be processed\n",
"example": 11,
"readOnly": false
},
"financialAndPayrollYearRelation": {
"type": "object",
"format": "metadata",
"readOnly": false,
"description": "This field indicates how the system should determine the (financial)period to book the results on.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of accounting period determination method",
"readOnly": false
},
"value": {
"type": "string",
"example": "Payroll Year -1",
"description": "description of the method\n\nWhen \"Op basis van schema\" is used `payrollPeriodFinancialPeriodMapping` must have a value. \nNote that not all applications support \"Op basis van schema\"",
"maxLength": 50,
"readOnly": true
}
}
}
}
}
},
"reportVoucherNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "boekstuknummer",
"readOnly": false
},
"credentials": {
"type": [
"object",
"null"
],
"properties": {
"username": {
"type": "string",
"maxLength": 255,
"example": "User123",
"description": "Gebruikersnaam",
"readOnly": false
},
"password": {
"type": [
"string",
"null"
],
"writeOnly": true,
"maxLength": 255,
"example": "**********"
}
}
},
"journalNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "Dagboek",
"readOnly": false
},
"subAdministration": {
"type": [
"string",
"null"
],
"example": "General ledger supermarkets salary",
"description": "Sub-Administratie",
"maxLength": 255,
"readOnly": false
},
"apiKey": {
"type": [
"string",
"null"
],
"example": null,
"description": "An API key",
"maxLength": 3072,
"readOnly": false,
"writeOnly": true
},
"allocation": {
"type": [
"string",
"null"
],
"example": "Salary",
"description": "Toewijzing",
"maxLength": 255,
"readOnly": false
},
"suspenseAccount": {
"type": [
"string",
"null"
],
"example": "SAL-4000",
"description": "The \"number\" for the suspense account (is a string)",
"minLength": 1,
"maxLength": 20,
"readOnly": false
},
"journalApplicationObjectGetPut": {
"type": "object",
"properties": {
"journalApplication": {
"$ref": "#/components/schemas/journalApplicationPut"
},
"financialAdministration": {
"$ref": "#/components/schemas/financialAdministration"
},
"journalCode": {
"$ref": "#/components/schemas/journalCode"
},
"account": {
"$ref": "#/components/schemas/account"
},
"description": {
"$ref": "#/components/schemas/description-5"
},
"isAutomatedExportEnabled": {
"$ref": "#/components/schemas/isAutomatedExportEnabled"
},
"methodForDeterminingAccountingPeriod": {
"$ref": "#/components/schemas/methodForDeterminingAccountingPeriod"
},
"deviatingJournalSeries": {
"$ref": "#/components/schemas/deviatingJournalSeries"
},
"linkCostCenterToGroup": {
"$ref": "#/components/schemas/linkCostCenterToGroup"
},
"linkCostUnitToGroup": {
"$ref": "#/components/schemas/linkCostUnitToGroup"
},
"includeCostCenter": {
"$ref": "#/components/schemas/includeCostCenter"
},
"includeCostUnit": {
"$ref": "#/components/schemas/includeCostUnit"
},
"payrollPeriodFinancialPeriodMapping": {
"$ref": "#/components/schemas/payrollPeriodFinancialPeriodMapping"
},
"reportVoucherNumber": {
"$ref": "#/components/schemas/reportVoucherNumber"
},
"credentials": {
"$ref": "#/components/schemas/credentials"
},
"journalNumber": {
"$ref": "#/components/schemas/journalNumber"
},
"subAdministration": {
"$ref": "#/components/schemas/subAdministration"
},
"apiKey": {
"$ref": "#/components/schemas/apiKey"
},
"allocation": {
"$ref": "#/components/schemas/allocation"
},
"suspenseAccount": {
"$ref": "#/components/schemas/suspenseAccount"
}
}
},
"journalApplicationPost": {
"type": "object",
"format": "metadata",
"readOnly": false,
"description": "The journal application (financial software for the general ledger). This field indicates how what export options are available by a journal run (as supported by the given application) and as such dictates the format of the export/download.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of journal application",
"readOnly": false
},
"value": {
"type": "string",
"example": "Precies Online",
"description": "Name of the journal application",
"maxLength": 50,
"readOnly": true
}
}
},
"journalApplicationObjectPost": {
"type": "object",
"properties": {
"journalApplication": {
"$ref": "#/components/schemas/journalApplicationPost"
},
"financialAdministration": {
"$ref": "#/components/schemas/financialAdministration"
},
"journalCode": {
"$ref": "#/components/schemas/journalCode"
},
"account": {
"$ref": "#/components/schemas/account"
},
"description": {
"$ref": "#/components/schemas/description-5"
},
"isAutomatedExportEnabled": {
"$ref": "#/components/schemas/isAutomatedExportEnabled"
},
"methodForDeterminingAccountingPeriod": {
"$ref": "#/components/schemas/methodForDeterminingAccountingPeriod"
},
"deviatingJournalSeries": {
"$ref": "#/components/schemas/deviatingJournalSeries"
},
"linkCostCenterToGroup": {
"$ref": "#/components/schemas/linkCostCenterToGroup"
},
"linkCostUnitToGroup": {
"$ref": "#/components/schemas/linkCostUnitToGroup"
},
"includeCostCenter": {
"$ref": "#/components/schemas/includeCostCenter"
},
"includeCostUnit": {
"$ref": "#/components/schemas/includeCostUnit"
},
"payrollPeriodFinancialPeriodMapping": {
"$ref": "#/components/schemas/payrollPeriodFinancialPeriodMapping"
},
"reportVoucherNumber": {
"$ref": "#/components/schemas/reportVoucherNumber"
},
"credentials": {
"$ref": "#/components/schemas/credentials"
},
"journalNumber": {
"$ref": "#/components/schemas/journalNumber"
},
"subAdministration": {
"$ref": "#/components/schemas/subAdministration"
},
"apiKey": {
"$ref": "#/components/schemas/apiKey"
},
"allocation": {
"$ref": "#/components/schemas/allocation"
},
"suspenseAccount": {
"$ref": "#/components/schemas/suspenseAccount"
}
}
},
"journalProfileProviderLevelObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"description": "The description of the journal profile.",
"example": "Journal profile supermarkets",
"minLength": 1,
"maxLength": 50,
"readOnly": false
},
"numberOfActiveAdministrations": {
"description": "The number of active administrations that use this journal profile.",
"type": "integer",
"format": "int32",
"example": 12,
"readOnly": true
},
"numberOfHistoricAdministrations": {
"description": "The number of administrations that used this journal profile in the past.",
"type": "integer",
"format": "int32",
"example": 42,
"readOnly": true
}
}
},
"journalProfilePostObject": {
"properties": {
"description": {
"type": "string",
"example": "General ledger supermarkets",
"description": "The description of the journal profile.",
"minLength": 1,
"maxLength": 50,
"readOnly": false
},
"journalProfileIdToCopy": {
"type": [
"string",
"null"
],
"format": "uuid",
"example": "00000000-0000-0000-0000-000000000001",
"description": "The unique identifier of the journal profile that should be copied.",
"readOnly": false
}
}
},
"number": {
"type": "string",
"example": "SAL-4000",
"description": "The \"number\" for a ledger account (is a string)",
"minLength": 1,
"maxLength": 20,
"readOnly": false
},
"description-6": {
"type": "string",
"example": "Salaris",
"description": "The description for a ledger account",
"minLength": 1,
"maxLength": 50,
"readOnly": false
},
"costAccount": {
"type": "boolean",
"description": "If set to true it is possible to devide costs for this account between cost centers and units.\nIf set to false it is not possible to devide costs for this account between cost centers and units.",
"readOnly": false
},
"consolidate": {
"type": "boolean",
"description": "If set to true and multiple payrollcomponents are linked to this account only the sum of all values is booked.\nIf set to false and multiple payrollcomponents are linked to this account all individual values is booked. If payroll component is not shown this will result in multiple lines with the same ledger account, cost center and cost unit probably with different values.",
"readOnly": false
},
"ledgerAccountProviderLevelObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"number": {
"$ref": "#/components/schemas/number"
},
"description": {
"$ref": "#/components/schemas/description-6"
},
"costAccount": {
"$ref": "#/components/schemas/costAccount"
},
"consolidate": {
"$ref": "#/components/schemas/consolidate"
}
}
},
"ledgerAccount": {
"type": "object",
"format": "metadata",
"properties": {
"id": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"number": {
"type": "string",
"example": "Salaris",
"description": "The description for a ledger account",
"readOnly": true
},
"description": {
"type": "string",
"example": "Salaris",
"description": "The description for a ledger account",
"readOnly": true
},
"costAccount": {
"type": "boolean",
"description": "If set to true it is possible to devide costs for this account between cost centers and units.\nIf set to false it is not possible to devide costs for this account between cost centers and units.",
"readOnly": true
},
"consolidate": {
"type": "boolean",
"description": "If set to true and multiple payrollcomponents are linked to this account only the sum of all values is booked.\nIf set to false and multiple payrollcomponents are linked to this account all individual values is booked. If payroll component is not shown this will result in multiple lines with the same ledger account, cost center and cost unit probably with different values.",
"readOnly": true
}
}
},
"payrollComponentReadOnly-2": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "A payroll component is the link to the salary calculation.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 70,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart.\n",
"readOnly": false
},
"description": {
"type": "string",
"example": "Wage",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Categorie"
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true,
"x-loket-db-field": "dbo.ctCategorie.omschrijving"
}
}
},
"balanceSheetSide": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "Indicates on what side (debit or credit) the value should go\n",
"readOnly": true
},
"value": {
"type": "string",
"example": "Credit",
"description": "The description of the side of the balance sheet\n",
"maxLength": 50,
"readOnly": true
}
}
}
}
},
"costCenter": {
"type": "object",
"format": "metadata",
"properties": {
"id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n\nThis Id has two special options with meaning\nIf id = null then this field is configured to not be relevant for the given ledgerAccount. (n.v.t)\nif id = a empty GUID then this record links the ledgerAccount to all costCenters that dont have their own unique line (Allemaal/Overig) ",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"code": {
"type": [
"string",
"null"
],
"example": "SAL073",
"description": "The code for a cost center",
"readOnly": true
},
"description": {
"type": "string",
"example": "Sales",
"description": "The description for a cost center",
"readOnly": true
}
}
},
"costUnit": {
"type": "object",
"format": "metadata",
"properties": {
"id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n\nThis Id has two special options with meaning\nIf id = null then this field is configured to not be relevant for the given ledgerAccount. (n.v.t)\nif id = a empty GUID then this record links the ledgerAccount to all costUnits that dont have their own unique line (Allemaal/Overig) ",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"code": {
"type": [
"string",
"null"
],
"example": "005",
"description": "The code for a cost unit",
"readOnly": true
},
"description": {
"type": "string",
"example": "Tilburg",
"description": "The description for a cost unit",
"readOnly": true
}
}
},
"ledgerAccountToPayrollComponentLinkAtProviderLevelObjectGetAndPatch": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"ledgerAccount": {
"$ref": "#/components/schemas/ledgerAccount"
},
"payrollComponent": {
"$ref": "#/components/schemas/payrollComponentReadOnly-2"
},
"costCenter": {
"$ref": "#/components/schemas/costCenter"
},
"costUnit": {
"$ref": "#/components/schemas/costUnit"
}
}
},
"payrollComponent-3": {
"type": "object",
"format": "metadata",
"description": "A payroll component is the link to the salary calculation.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 70,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart.\n",
"readOnly": false
},
"description": {
"type": "string",
"example": "Wage",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Categorie"
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true,
"x-loket-db-field": "dbo.ctCategorie.omschrijving"
}
}
},
"balanceSheetSide": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "Indicates on what side (debit or credit) the value should go\n",
"readOnly": true
},
"value": {
"type": "string",
"example": "Credit",
"description": "The description of the side of the balance sheet\n",
"maxLength": 50,
"readOnly": true
}
}
}
}
},
"ledgerAccountToPayrollComponentLinkAtProviderLevelObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"ledgerAccount": {
"$ref": "#/components/schemas/ledgerAccount"
},
"payrollComponent": {
"$ref": "#/components/schemas/payrollComponent-3"
},
"costCenter": {
"$ref": "#/components/schemas/costCenter"
},
"costUnit": {
"$ref": "#/components/schemas/costUnit"
}
}
},
"costCenterProviderLevelObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"code": {
"type": "string",
"example": "SAL073",
"description": "The code for a cost center",
"minLength": 1,
"maxLength": 20,
"readOnly": false,
"x-loket-db-field": "Ulsa.AdministratiekantoorKostenplaats.Code"
},
"description": {
"type": "string",
"example": "Sales",
"description": "The description for a cost center",
"minLength": 1,
"maxLength": 50,
"readOnly": false,
"x-loket-db-field": "Ulsa.AdministratiekantoorKostenplaats.Omschrijving"
},
"automaticallyLinkToAllCostUnits": {
"type": "boolean",
"example": false,
"description": "Indicates whether this cost center will be automatically be linked to all cost units. \n\n__Note:__ This field is no longer supported but due to backwards compatibility we return the value as readOnly. When creating a new record the value is set to \"false\"",
"readOnly": true
}
}
},
"costUnitProviderLevelObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"code": {
"type": "string",
"example": "SAL073",
"description": "The code for a cost unit",
"minLength": 1,
"maxLength": 20,
"readOnly": false,
"x-loket-db-field": "Ulsa.AdministratiekantoorKostenplaats.Code"
},
"description": {
"type": "string",
"example": "Sales",
"description": "The description for a cost unit",
"minLength": 1,
"maxLength": 50,
"readOnly": false,
"x-loket-db-field": "Ulsa.AdministratiekantoorKostenplaats.Omschrijving"
},
"automaticallyLinkToAllCostCenters": {
"type": "boolean",
"example": false,
"description": "Indicates whether this cost center will be automatically be linked to all cost units. \n\n__Note:__ This field is no longer supported but due to backwards compatibility we return the value as readOnly. When creating a new record the value is set to \"false\"",
"readOnly": true
}
}
},
"matrixObject": {
"properties": {
"costCenter": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"code": {
"type": "string",
"example": "SAL073",
"description": "The code for a cost center",
"readOnly": true
},
"description": {
"type": "string",
"example": "Sales",
"description": "The description for a cost center",
"readOnly": true
}
}
},
"costUnit": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"code": {
"type": "string",
"example": "005",
"description": "The code for a cost unit",
"readOnly": true
},
"description": {
"type": "string",
"example": "Tilburg",
"description": "The description for a cost unit",
"readOnly": true
}
}
},
"linked": {
"type": "boolean",
"description": "If true the given combination of cost center and cost unit are linked.\nLinked means that the combination can be selected in the \"Ledger account to payroll component mapping\" and \"journal allocation\" on employment level.",
"readOnly": false
},
"locked": {
"type": "boolean",
"description": "If true the given link between cost center and cost unit is locked and cannot be disabled. This is due to the `automaticallyLinkToAllCostCenters` and `automaticallyLinkToAllCostUnits` fields",
"readOnly": true
}
}
},
"origin": {
"type": "integer",
"example": 1,
"description": "Meaning of the integer:\n* 1 = CAO\n* 2 = Loonmodel\n* 3 = Administratie (Ulsa werkgever)\n* 4 = Provider",
"readOnly": true
},
"journalProfileObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true
},
"description": {
"type": "string",
"example": "General ledger supermarkets",
"minLength": 1,
"maxLength": 50,
"readOnly": false
},
"origin": {
"type": "object",
"description": "All fields in this object are related to their namesake in the output. They indicate for that field on what level the value was defined.",
"properties": {
"key": {
"$ref": "#/components/schemas/origin"
},
"description": {
"$ref": "#/components/schemas/origin"
}
}
}
}
},
"origin-2": {
"type": "object",
"readOnly": true,
"description": "All fields in this object are related to their namesake in the output. They indicate for that field on what level the value was defined.\nMeaning of the integer:\n* 1 = CAO * 2 = Loonmodel * 3 = Administratie (Ulsa werkgever) * 4 = Provider",
"properties": {
"number": {
"$ref": "#/components/schemas/origin"
},
"description": {
"$ref": "#/components/schemas/origin"
},
"costAccount": {
"$ref": "#/components/schemas/origin"
},
"consolidate": {
"$ref": "#/components/schemas/origin"
}
}
},
"ledgerAccountObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"number": {
"$ref": "#/components/schemas/number"
},
"description": {
"$ref": "#/components/schemas/description-6"
},
"costAccount": {
"$ref": "#/components/schemas/costAccount"
},
"consolidate": {
"$ref": "#/components/schemas/consolidate"
},
"origin": {
"$ref": "#/components/schemas/origin-2"
}
}
},
"origin-3": {
"type": "object",
"readOnly": true,
"description": "All fields in this object are related to their namesake in the output. They indicate for that field on what level the value was defined.\nMeaning of the integer:\n* 1 = CAO\n* 2 = Loonmodel\n* 3 = Administratie (Ulsa werkgever)\n* 4 = Provider",
"properties": {
"ledgerAccount": {
"$ref": "#/components/schemas/origin"
},
"payrollComponent": {
"$ref": "#/components/schemas/origin"
},
"costCenter": {
"$ref": "#/components/schemas/origin"
},
"costUnit": {
"$ref": "#/components/schemas/origin"
}
}
},
"ledgerAccountToPayrollComponentLinkObjectGetAndPatch": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"ledgerAccount": {
"$ref": "#/components/schemas/ledgerAccount"
},
"payrollComponent": {
"$ref": "#/components/schemas/payrollComponentReadOnly-2"
},
"costCenter": {
"$ref": "#/components/schemas/costCenter"
},
"costUnit": {
"$ref": "#/components/schemas/costUnit"
},
"origin": {
"$ref": "#/components/schemas/origin-3"
}
}
},
"ledgerAccountToPayrollComponentLinkObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"ledgerAccount": {
"$ref": "#/components/schemas/ledgerAccount"
},
"payrollComponent": {
"$ref": "#/components/schemas/payrollComponent-3"
},
"costCenter": {
"$ref": "#/components/schemas/costCenter"
},
"costUnit": {
"$ref": "#/components/schemas/costUnit"
},
"origin": {
"$ref": "#/components/schemas/origin"
}
}
},
"ledgerAccountToPayrollComponentLinkObjectMetadata": {
"properties": {
"field": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"costCenterObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"code": {
"type": "string",
"example": "SAL073",
"description": "The code for a cost center",
"minLength": 1,
"maxLength": 20,
"readOnly": false,
"x-loket-db-field": "Ulsa.Kostenplaats.Code"
},
"description": {
"type": "string",
"example": "Sales",
"description": "The description for a cost center",
"minLength": 1,
"maxLength": 50,
"readOnly": false,
"x-loket-db-field": "Ulsa.Kostenplaats.Omschrijving"
},
"automaticallyLinkToAllCostUnits": {
"type": "boolean",
"example": false,
"description": "Indicates whether this cost center will be automatically be linked to all cost units. \n\n__Note:__ This field is no longer supported but due to backwards compatibility we return the value as readOnly. When creating a new record the value is set to \"false\"",
"readOnly": true
},
"origin": {
"type": "object",
"readOnly": true,
"description": "All fields in this object are related to their namesake in the output. They indicate for that field on what level the value was defined.\nMeaning of the integer:\n* 1 = CAO\n* 2 = Loonmodel\n* 3 = Administratie (Ulsa werkgever)\n* 4 = Provider",
"properties": {
"code": {
"$ref": "#/components/schemas/origin"
},
"description": {
"$ref": "#/components/schemas/origin"
},
"automaticallyLinkToAllCostUnits": {
"$ref": "#/components/schemas/origin"
}
}
}
}
},
"costUnitObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"code": {
"type": "string",
"example": "SAL073",
"description": "The code for a cost unit",
"minLength": 1,
"maxLength": 20,
"readOnly": false,
"x-loket-db-field": "Ulsa.Kostenplaats.Code"
},
"description": {
"type": "string",
"example": "Sales",
"description": "The description for a cost unit",
"minLength": 1,
"maxLength": 50,
"readOnly": false,
"x-loket-db-field": "Ulsa.Kostenplaats.Omschrijving"
},
"automaticallyLinkToAllCostCenters": {
"type": "boolean",
"example": false,
"description": "Indicates whether this cost unit will be automaticly be linked to all cost units. \n\n__Note:__ This field is no longer supported but due to backwards compatibility we return the value as readOnly. When creating a new record the value is set to \"false\"",
"readOnly": true
},
"origin": {
"type": "object",
"readOnly": true,
"description": "All fields in this object are related to their namesake in the output. They indicate for that field on what level the value was defined.\nMeaning of the integer:\n* 1 = CAO\n* 2 = Loonmodel\n* 3 = Administratie (Ulsa werkgever)\n* 4 = Provider",
"properties": {
"code": {
"$ref": "#/components/schemas/origin"
},
"description": {
"$ref": "#/components/schemas/origin"
},
"automaticallyLinkToAllCostCenters": {
"$ref": "#/components/schemas/origin"
}
}
}
}
},
"userSet": {
"type": "object",
"properties": {
"personalDetails": {
"type": [
"object",
"null"
],
"readOnly": false,
"properties": {
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name of the user",
"maxLength": 28,
"readOnly": false
},
"initials": {
"type": "string",
"example": "S.L.",
"description": "The initials of the user",
"maxLength": 6,
"readOnly": false
},
"prefix": {
"type": [
"string",
"null"
],
"example": "van",
"description": "The prefix of the user",
"maxLength": 10,
"readOnly": false
},
"lastName": {
"type": "string",
"example": "Bergen",
"description": "The last name of the user",
"maxLength": 25,
"readOnly": false
}
}
},
"contactInformation": {
"type": [
"object",
"null"
],
"readOnly": false,
"properties": {
"placeOfEmployment": {
"type": [
"string",
"null"
],
"example": "Amsterdam office",
"description": "The place of employment (standplaats) for the user.",
"maxLength": 24,
"minLength": 1,
"readOnly": false
},
"phoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 13-1234567",
"description": "The phone number of the user.",
"maxLength": 15,
"minLength": 1,
"readOnly": false
},
"emailAddress": {
"type": "string",
"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])))$",
"example": "info@loket.nl",
"description": "The e-mail address of the user.",
"maxLength": 255,
"readOnly": true
}
}
},
"user": {
"type": [
"object",
"null"
],
"readOnly": false,
"properties": {
"userSpecifiedRole": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The Role which the user has specified.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false
},
"value": {
"type": "string",
"example": "Salarisadministrateur",
"maxLength": 50,
"readOnly": true
}
}
},
"userCustomSpecifiedRole": {
"type": [
"string",
"null"
],
"description": "Further specification of the user role.\n",
"example": "Secretariaat medewerker",
"maxLength": 50,
"readOnly": false
}
}
},
"photo": {
"type": [
"string",
"null"
],
"format": "url",
"example": "https://api.loket.nl/v2/user/photo/{version}",
"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.",
"readOnly": true
}
}
},
"userMinimized": {
"type": "object",
"properties": {
"personalDetails": {
"type": [
"object",
"null"
],
"readOnly": false,
"properties": {
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name of the user",
"readOnly": true
},
"initials": {
"type": "string",
"example": "S.L.",
"description": "The initials of the user",
"readOnly": true
},
"prefix": {
"type": [
"string",
"null"
],
"example": "van",
"description": "The prefix of the user",
"readOnly": true
},
"lastName": {
"type": "string",
"example": "Bergen",
"description": "The last name of the user",
"readOnly": true
},
"formattedName": {
"type": "string",
"example": "S. van Bergen",
"description": "The formatted name of the user",
"readOnly": true
}
}
}
}
},
"userSettings": {
"type": "object",
"properties": {
"employmentFilter": {
"type": "object",
"properties": {
"filterOnDepartments": {
"type": "array",
"items": {
"type": [
"object",
"null"
],
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
}
}
}
},
"filterOnFunctions": {
"type": "array",
"items": {
"type": [
"object",
"null"
],
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
}
}
}
},
"filterOnEmployedStatus": {
"type": "string",
"enum": [
"AllEmployments",
"ActiveEmployments",
"ActiveAndFutureEmployments",
"ActiveAndHistoricEmployments",
"ActiveInOrAfterCurrentYearEmployments"
],
"description": "Filter on the employedStatus, based on the start and end date of the employment.",
"readOnly": false
},
"filterOnOnCallEmployment": {
"type": [
"boolean",
"null"
],
"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."
},
"filterOnAdministrations": {
"type": "array",
"items": {
"type": [
"object",
"null"
],
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
}
}
}
},
"filterOnEmploymentTypes": {
"type": "array",
"items": {
"type": [
"object",
"null"
],
"properties": {
"key": {
"type": "integer",
"format": "int32",
"description": "The key identifying the employment category type",
"example": 1,
"readOnly": false
}
}
}
},
"referenceDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2024-01-01",
"description": "The reference date for the filter. If not provided, the current date will be used."
}
}
}
}
},
"loginMethod": {
"type": "object",
"format": "metadata",
"description": "The allowedlogin method for the user",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false
},
"value": {
"type": "string",
"example": "Only via SSO",
"maxLength": 50,
"readOnly": true
}
}
},
"firstName-2": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name of the user",
"maxLength": 28,
"minLength": 1,
"readOnly": false
},
"initials-3": {
"type": "string",
"example": "S.L.",
"pattern": "^[A-Za-zÀ-ÖØ-öø-ÿ]{1,6}$",
"description": "The initials of the user",
"maxLength": 6,
"minLength": 1,
"readOnly": false
},
"prefix-2": {
"type": [
"string",
"null"
],
"example": "van",
"description": "The prefix of the user",
"maxLength": 10,
"minLength": 1,
"readOnly": false
},
"lastName-2": {
"type": "string",
"example": "Bergen",
"description": "The last name of the user",
"pattern": "^[A-Za-zÀ-ÖØ-öø-ÿ]{1,25}$",
"maxLength": 25,
"minLength": 1,
"readOnly": false
},
"contactInformation-4": {
"type": "object",
"properties": {
"placeOfEmployment": {
"type": [
"string",
"null"
],
"example": "Amsterdam office",
"description": "The place of employment (standplaats) for the user.",
"maxLength": 24,
"minLength": 1,
"readOnly": false
},
"phoneNumber": {
"type": [
"string",
"null"
],
"example": "+31 13-1234567",
"description": "The phone number of the user.",
"maxLength": 15,
"minLength": 1,
"readOnly": false
},
"emailAddress": {
"type": "string",
"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])))$",
"example": "info@loket.nl",
"description": "The e-mail address of the user.",
"maxLength": 255,
"readOnly": false
}
}
},
"userSpecifiedRole": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The Role which the user has specified.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": false
},
"value": {
"type": "string",
"example": "Salarisadministrateur",
"maxLength": 50,
"readOnly": true
}
}
},
"userCustomSpecifiedRole": {
"type": [
"string",
"null"
],
"description": "Further specification of the user role.\n",
"example": "Secretariaat medewerker",
"maxLength": 50,
"readOnly": false
},
"accessStatus": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "indicates the access status of the user.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": true
},
"value": {
"type": "string",
"example": "Has access to Client",
"maxLength": 255,
"readOnly": true
}
}
},
"hasMultiFactorAuthentication": {
"type": "boolean",
"example": false,
"description": "Indicates if the user has multi factor authentication enabled\n\nCan only be changed from true to false.",
"readOnly": false
},
"twoFactorAuthenticationRequired": {
"type": "boolean",
"example": false,
"description": "Indicates whether two factor authentication is required for the user. This setting is only available for login method: Via website en SSO ",
"readOnly": false
},
"azureActiveDirectory": {
"type": [
"object",
"null"
],
"properties": {
"tenant": {
"type": "object",
"format": "metadata",
"description": "The Azure AD tennant",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Id for the tennant",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"description": {
"type": "string",
"example": "Customer X Azure AD",
"maxLength": 100,
"readOnly": true
},
"tenantRegistrationLevel": {
"type": "string",
"enum": [
"provider",
"provider"
],
"readOnly": true
}
}
},
"userId": {
"type": "string",
"description": "The userId as known in the Azure AD of the selected tennant",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
}
}
},
"userNameReadOnly": {
"type": [
"string",
"null"
],
"example": "User42",
"maxLength": 50,
"minLength": 3,
"description": "The username",
"readOnly": true
},
"hasIntegrations": {
"type": "boolean",
"example": false,
"description": "Indicates if the user has integrations with clients other that Loket",
"readOnly": true
},
"hasConnectedApplications": {
"type": "boolean",
"example": false,
"description": "Indicates if the user has connected applications (a conection with different software via this user)",
"readOnly": true
},
"hasAuthorisationsOnUserLevel": {
"type": "boolean",
"example": false,
"description": "Indicates if the user has authorizations set on user level. \nIf set user level authorizations overwrite team based authorizations",
"readOnly": true
},
"dateTimeLastLogin": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2021-01-19",
"description": "The date on which the user loged in for the last time",
"readOnly": true
},
"dateTimeCreation": {
"type": "string",
"format": "date-time",
"example": "2020-01-19",
"description": "The date on which the user was created",
"readOnly": true
},
"authorizationSet": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"description": "The authorization set for the user. ",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": true
},
"value": {
"type": "string",
"example": "Salarisadministrateur",
"maxLength": 50,
"readOnly": true
}
}
},
"userGetAndPut": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"loginMethod": {
"$ref": "#/components/schemas/loginMethod"
},
"personalDetails": {
"type": "object",
"properties": {
"firstName": {
"$ref": "#/components/schemas/firstName-2"
},
"initials": {
"$ref": "#/components/schemas/initials-3"
},
"prefix": {
"$ref": "#/components/schemas/prefix-2"
},
"lastName": {
"$ref": "#/components/schemas/lastName-2"
}
}
},
"contactInformation": {
"$ref": "#/components/schemas/contactInformation-4"
},
"userSpecifiedRole": {
"$ref": "#/components/schemas/userSpecifiedRole"
},
"userCustomSpecifiedRole": {
"$ref": "#/components/schemas/userCustomSpecifiedRole"
},
"accessStatus": {
"$ref": "#/components/schemas/accessStatus"
},
"hasMultiFactorAuthentication": {
"$ref": "#/components/schemas/hasMultiFactorAuthentication"
},
"twoFactorAuthenticationRequired": {
"$ref": "#/components/schemas/twoFactorAuthenticationRequired"
},
"azureActiveDirectory": {
"$ref": "#/components/schemas/azureActiveDirectory"
},
"userName": {
"$ref": "#/components/schemas/userNameReadOnly"
},
"hasIntegrations": {
"$ref": "#/components/schemas/hasIntegrations"
},
"hasConnectedApplications": {
"$ref": "#/components/schemas/hasConnectedApplications"
},
"hasAuthorisationsOnUserLevel": {
"$ref": "#/components/schemas/hasAuthorisationsOnUserLevel"
},
"dateTimeLastLogin": {
"$ref": "#/components/schemas/dateTimeLastLogin"
},
"dateTimeCreation": {
"$ref": "#/components/schemas/dateTimeCreation"
},
"authorizationSet": {
"$ref": "#/components/schemas/authorizationSet"
}
}
},
"hasAccessToPayrollingTestData": {
"type": "boolean",
"example": false,
"description": "Indicates if the user has access to data for payrolling test years",
"readOnly": false,
"x-loket-comment": "loket.gebruiker.loonoutputTestJaarZichtbaar"
},
"userPost": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"loginMethod": {
"$ref": "#/components/schemas/loginMethod"
},
"personalDetails": {
"type": "object",
"properties": {
"initials": {
"$ref": "#/components/schemas/initials-3"
},
"prefix": {
"$ref": "#/components/schemas/prefix-2"
},
"lastName": {
"$ref": "#/components/schemas/lastName-2"
}
}
},
"contactInformation": {
"$ref": "#/components/schemas/contactInformation-4"
},
"hasAccessToPayrollingTestData": {
"$ref": "#/components/schemas/hasAccessToPayrollingTestData"
},
"azureActiveDirectory": {
"type": [
"object",
"null"
],
"properties": {
"tenant": {
"type": "object",
"format": "metadata",
"description": "The Azure AD tennant",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Id for the tennant",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
}
}
},
"userId": {
"type": "string",
"format": "uuid",
"description": "The userId as known in the Azure AD of the selected tennant",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"userName": {
"type": "string",
"example": "User123",
"maxLength": 50,
"minLength": 3,
"readOnly": false
}
}
},
"ssoAccount": {
"type": [
"object",
"null"
],
"properties": {
"userName": {
"type": "string",
"example": "Customer X Azure AD",
"maxLength": 50,
"minLength": 3,
"readOnly": false
},
"password": {
"type": "string",
"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]))^.*",
"example": "Password%6",
"maxLength": 255,
"minLength": 8,
"description": "The password",
"readOnly": false
}
}
}
}
},
"manageLoketAccess": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"RevokeAccess",
"ReinstateAccess",
"RevokeAccessLoketClassicOnly",
"ReinstateAccessLoketClassicOnly"
],
"description": "indicates the action to perform.",
"readOnly": false
}
}
},
"userInvite": {
"type": "object",
"properties": {
"personalDetails": {
"type": "object",
"properties": {
"initials": {
"$ref": "#/components/schemas/initials-3"
},
"prefix": {
"$ref": "#/components/schemas/prefix-2"
},
"lastName": {
"$ref": "#/components/schemas/lastName-2"
}
}
},
"contactInformation": {
"$ref": "#/components/schemas/contactInformation-4"
},
"twoFactorAuthenticationRequired": {
"$ref": "#/components/schemas/twoFactorAuthenticationRequired"
},
"hasAccessToPayrollingTestData": {
"$ref": "#/components/schemas/hasAccessToPayrollingTestData"
},
"destinationForSecret": {
"type": "string",
"pattern": "^(0\\d{9})$|(^(\\+(?=31)\\d{11}$)|^(\\+(?!31)(?!0)\\d{8,14}$))",
"description": "The destination phonenumber to sent the secret to during registration.",
"example": "0612345678",
"maxLength": 15,
"minLength": 3,
"readOnly": false
}
}
},
"patchUserInvite": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"Resend",
"Revoke"
],
"description": "indicates the action to perform.",
"readOnly": false
},
"resendInformation": {
"type": [
"object",
"null"
],
"description": "Only include this object if action is Resend",
"properties": {
"destinationForSecret": {
"type": "string",
"pattern": "^(0\\d{9})$|(^(\\+(?=31)\\d{11}$)|^(\\+(?!31)(?!0)\\d{8,14}$))",
"description": "The destination phonenumber to sent the secret to during registration.",
"example": "0612345678",
"maxLength": 15,
"minLength": 3,
"readOnly": false
},
"emailAddress": {
"type": "string",
"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])))$",
"example": "info@loket.nl",
"description": "The e-mail address of the user.",
"maxLength": 255,
"readOnly": false
},
"providerId": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"twoFactorAuthenticationRequired": {
"$ref": "#/components/schemas/twoFactorAuthenticationRequired"
}
}
}
}
},
"authorizationSet-2": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"description": {
"type": "string",
"example": "HR Gebruiker",
"maxLength": 50,
"readOnly": true
}
}
},
"authorization": {
"type": "object",
"properties": {
"authorizationSet": {
"$ref": "#/components/schemas/authorizationSet-2"
},
"authorizations": {
"$ref": "#/components/schemas/authorizations"
}
}
},
"authorizationGroup": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Team oost Nederland",
"description": "The description of the authorization group (team)",
"minLength": 1,
"maxLength": 50,
"readOnly": true
},
"numberOfLinkedUsers": {
"type": "integer",
"format": "int32",
"example": 435,
"description": "The number of provider users that are linked to this authorization group",
"readOnly": true
},
"numberOfLinkedEmployers": {
"type": "integer",
"format": "int32",
"example": 435,
"description": "The number of employers that are linked to this authorization group",
"readOnly": true
},
"authorizationSet": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"description": {
"type": "string",
"example": "HR Gebruiker",
"maxLength": 50,
"readOnly": true
}
}
},
"isLinked": {
"type": "boolean",
"description": "Indicates if a user is linked to the given authorization group.",
"readOnly": true
}
}
},
"client": {
"type": "object",
"properties": {
"lastLogin": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time the user loged in to the client",
"readOnly": true
},
"accessStatus": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "indicates the access status of the user.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": true
},
"value": {
"type": "string",
"example": "Has access to Client",
"maxLength": 255,
"readOnly": true
}
}
},
"client": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"example": "ABC-I",
"maxLength": 100,
"readOnly": true
},
"consumerFriendlyName": {
"type": [
"string",
"null"
],
"example": "ABC international",
"maxLength": 100,
"readOnly": true
}
}
}
}
},
"authorizationGroupObject": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Team oost Nederland",
"description": "The description of the authorization group (team)",
"minLength": 1,
"maxLength": 50,
"readOnly": false
},
"numberOfLinkedUsers": {
"type": "integer",
"format": "int32",
"example": 435,
"description": "The number of provider users that are linked to this authorization group",
"readOnly": true
},
"numberOfLinkedEmployers": {
"type": "integer",
"format": "int32",
"example": 435,
"description": "The number of employers that are linked to this authorization group",
"readOnly": true
},
"authorizationSet": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"description": {
"type": "string",
"example": "HR Gebruiker",
"maxLength": 50,
"readOnly": true
}
}
}
}
},
"employersObject": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"companyName": {
"type": "string",
"example": "Voorbeeld B.V.",
"description": "Name of the company",
"maxLength": 70,
"readOnly": true
},
"administrationNumber": {
"type": [
"string",
"null"
],
"example": "SR2",
"description": "A free field that is most commonly used to store the Debtors number the provider uses for the employer.",
"maxLength": 15,
"readOnly": true
},
"groupCode": {
"format": "int32",
"type": [
"integer",
"null"
],
"description": "The groupcode is used for grouping employers.",
"example": 40,
"minimum": 1,
"readOnly": true
},
"isLinked": {
"type": "boolean",
"description": "Indicates if an employer is linked to the authorization group",
"readOnly": true
}
}
},
"employersObjectPatch": {
"type": "array",
"items": {
"type": "string",
"format": "UUID"
}
},
"usersObject": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"personalDetails": {
"type": "object",
"readOnly": true,
"properties": {
"firstName": {
"$ref": "#/components/schemas/firstName-2"
},
"initials": {
"$ref": "#/components/schemas/initials-3"
},
"prefix": {
"$ref": "#/components/schemas/prefix-2"
},
"lastName": {
"$ref": "#/components/schemas/lastName-2"
}
}
},
"userName": {
"type": [
"string",
"null"
],
"example": "User42",
"maxLength": 50,
"minLength": 3,
"pattern": "^[A-Za-z0-9_.@-]+$",
"description": "The username",
"readOnly": true
},
"isLinked": {
"type": "boolean",
"description": "Indicates if a user is linked to the given authorization group.",
"readOnly": true
},
"hasAuthorizationsOnUserLevel": {
"type": "boolean",
"description": "true if the given user is configured with authorizations on the user level. User lever authorizations overwrite the authorizations on team level.",
"readOnly": true
},
"hasMultipleTeams": {
"type": "boolean",
"description": "true if the given user is linked to multiple teams",
"readOnly": true
},
"hasIntegrations": {
"type": "boolean",
"example": false,
"description": "Indicates if the user has integrations with clients other that Loket",
"readOnly": true
}
}
},
"userObjectPatch": {
"type": "array",
"items": {
"type": "string",
"format": "UUID"
}
},
"authorizationGroupObject-2": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Team oost Nederland",
"description": "The description of the authorization group (team)",
"minLength": 1,
"maxLength": 50,
"readOnly": false
},
"numberOfLinkedUsers": {
"type": "integer",
"format": "int32",
"example": 435,
"description": "The number of provider users that are linked to this authorization group",
"readOnly": true
},
"numberOfLinkedEmployers": {
"type": "integer",
"format": "int32",
"example": 435,
"description": "The number of employers that are linked to this authorization group",
"readOnly": true
},
"authorizationSet": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"description": {
"type": "string",
"example": "HR Gebruiker",
"maxLength": 50,
"readOnly": true
}
}
},
"isLinked": {
"type": "boolean",
"description": "Indicates if an employer is linked to the authorization group",
"readOnly": true
},
"currentUser": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"properties": {
"isAuthorizedToManageEmployerAuthorizationGroups": {
"type": "boolean",
"description": "true if the loged in user is authorized to manage which authorization groups (teams) an employer is linked to.",
"readOnly": true
},
"isAuthorizedToManageEmployerModules": {
"type": "boolean",
"description": "true if the loged in user is authorized to manage which moduels (producten) an employer is linked to.",
"readOnly": true
},
"isAuthorizedToAddPayrollAdministrations": {
"type": "boolean",
"description": "true if the loged in user is authorized to add payroll administrations (verloning/administratie) to the employer.",
"readOnly": true
}
}
}
}
},
"authorizationGroupObjectPatch": {
"type": "array",
"items": {
"type": "string",
"format": "UUID"
}
},
"integration": {
"type": "object",
"properties": {
"createdOn": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time the integration was successfully initiated",
"readOnly": true
},
"lastLogin": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time the integration was last active",
"readOnly": true
},
"isBlocked": {
"type": "boolean",
"example": true,
"description": "Indicates whether the application user combination is blocked (for this single user)",
"readOnly": false
},
"application": {
"type": "object",
"readOnly": true,
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": [
"string",
"null"
],
"example": "ABC international",
"maxLength": 100,
"readOnly": true
},
"logo": {
"type": [
"string",
"null"
],
"example": "https://api.loket.nl/v2/application/{applicationId}/logo/{version}",
"description": "An URI to the logo of the client",
"readOnly": true
},
"isBlocked": {
"type": "boolean",
"example": true,
"description": "Indicates whether the application as a whole is blocked (for all users)",
"readOnly": true
},
"isAvailableInMarketplace": {
"type": "boolean",
"example": true,
"description": "Indicates whether the application is available in the marketplace and the GUI can link to it.",
"readOnly": true
}
}
}
}
},
"connectedApplications": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Connection for HpGL",
"description": "Descrition of the connection",
"readOnly": false
},
"key": {
"type": "integer",
"format": "int32",
"example": 21,
"description": "because users tend te use the same description for multiple connected applications we added this field as an extra unique identifier",
"readOnly": true
},
"applicationProvider": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Precies online",
"maxLength": 100,
"readOnly": true
}
}
},
"createdOn": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time the integration was successfully initiated",
"readOnly": true
},
"lastUsedOn": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time the integration was last active",
"readOnly": true
}
}
},
"connectedApplicationPatch": {
"type": "object",
"properties": {
"state": {
"type": "string",
"example": "lshjgoi7329o4nsldjuf0s9udjfsd09fsdjfpsd98234ln",
"description": "The state as given in the first step of the Oauth code flow",
"readOnly": false
},
"code": {
"type": "string",
"example": "lshjgoi7329o4nsldjuf0s9udjfsd09fsdjfpsd98234ln0498yjhkjk379u4yijrhkg394yurjeogk39y54oerkhgf24pwrojgfkl94ypuroejghkf9y4rpjhkd93y45evrjhdk943y5uprjeok",
"description": "The new refresh token of the Oauth refresh flow",
"readOnly": false
}
}
},
"connectedApplicationInitiateRequest": {
"type": "object",
"properties": {
"description": {
"type": [
"string",
"null"
],
"example": "Precies online",
"maxLength": 250,
"readOnly": false
},
"applicationProvider": {
"type": "object",
"format": "metadata",
"readOnly": false,
"properties": {
"id": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"description": {
"type": "string",
"example": "Precies online",
"maxLength": 100,
"readOnly": true
}
}
}
}
},
"connectedApplicationUrlResponse": {
"type": "object",
"properties": {
"authorizeUrl": {
"type": "string",
"format": "url",
"example": "https://oauth.externalApplication.nl/autorize?clientId=123&clientSecret=456&etc=etc",
"readOnly": true
}
}
},
"connectedApplicationRefreshRequest": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/idReadOnlyFalse"
}
}
},
"azureActiveDirectory-2": {
"type": [
"object",
"null"
],
"properties": {
"tenant": {
"type": "object",
"format": "metadata",
"description": "The Azure AD tennant",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Id for the tennant",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"description": {
"type": "string",
"example": "Customer X Azure AD",
"maxLength": 100,
"readOnly": true
},
"tenantRegistrationLevel": {
"type": "string",
"enum": [
"provider",
"employer"
],
"readOnly": true
}
}
},
"userId": {
"type": "string",
"description": "The userId as known in the Azure AD of the selected tennant",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
}
}
},
"isDepartmentManager": {
"type": "boolean",
"example": false,
"description": "Indicates if the user is a department manager",
"readOnly": true
},
"isLinkedToMultipleEmployers": {
"type": "boolean",
"example": false,
"description": "Indicates if the user has access to multiple employer.",
"readOnly": true
},
"hasIntegrations-2": {
"type": "boolean",
"example": false,
"description": "Indicates if the user has integrations with clients other that Loket. This means that another application can call the loket API using this user.",
"readOnly": true
},
"hasConnectedApplications-2": {
"type": "boolean",
"example": false,
"description": "Indicates if the user has connected applications.In this case a conection was made where loket can call the external softwares api to read and/or write data for that system.",
"readOnly": true
},
"userGetAndPut-2": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"loginMethod": {
"$ref": "#/components/schemas/loginMethod"
},
"personalDetails": {
"type": "object",
"properties": {
"firstName": {
"$ref": "#/components/schemas/firstName-2"
},
"initials": {
"$ref": "#/components/schemas/initials-3"
},
"prefix": {
"$ref": "#/components/schemas/prefix-2"
},
"lastName": {
"$ref": "#/components/schemas/lastName-2"
}
}
},
"contactInformation": {
"$ref": "#/components/schemas/contactInformation-4"
},
"userSpecifiedRole": {
"$ref": "#/components/schemas/userSpecifiedRole"
},
"userCustomSpecifiedRole": {
"$ref": "#/components/schemas/userCustomSpecifiedRole"
},
"hasAccessToPayrollingTestData": {
"$ref": "#/components/schemas/hasAccessToPayrollingTestData"
},
"accessStatus": {
"$ref": "#/components/schemas/accessStatus"
},
"hasMultiFactorAuthentication": {
"$ref": "#/components/schemas/hasMultiFactorAuthentication"
},
"twoFactorAuthenticationRequired": {
"$ref": "#/components/schemas/twoFactorAuthenticationRequired"
},
"azureActiveDirectory": {
"$ref": "#/components/schemas/azureActiveDirectory-2"
},
"userName": {
"$ref": "#/components/schemas/userNameReadOnly"
},
"isDepartmentManager": {
"$ref": "#/components/schemas/isDepartmentManager"
},
"isLinkedToMultipleEmployers": {
"$ref": "#/components/schemas/isLinkedToMultipleEmployers"
},
"hasIntegrations": {
"$ref": "#/components/schemas/hasIntegrations-2"
},
"hasConnectedApplications": {
"$ref": "#/components/schemas/hasConnectedApplications-2"
},
"dateTimeLastLogin": {
"$ref": "#/components/schemas/dateTimeLastLogin"
},
"dateTimeCreation": {
"$ref": "#/components/schemas/dateTimeCreation"
}
}
},
"patchUserInvite-2": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"Resend",
"Revoke"
],
"description": "indicates the action to perform.",
"readOnly": false
},
"resendInformation": {
"type": [
"object",
"null"
],
"description": "Only include this object if action is Resend",
"properties": {
"destinationForSecret": {
"type": "string",
"pattern": "^(0\\d{9})$|(^(\\+(?=31)\\d{11}$)|^(\\+(?!31)(?!0)\\d{8,14}$))",
"description": "The destination phonenumber to sent the secret to during registration.",
"example": "0612345678",
"maxLength": 15,
"minLength": 3,
"readOnly": false
},
"emailAddress": {
"type": "string",
"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])))$",
"example": "info@loket.nl",
"description": "The e-mail address of the user.",
"maxLength": 255,
"readOnly": false
},
"employerId": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"twoFactorAuthenticationRequired": {
"$ref": "#/components/schemas/twoFactorAuthenticationRequired"
}
}
}
}
},
"deleteInformation": {
"type": "object",
"properties": {
"numberOfUnreadNotifications": {
"type": "integer",
"format": "int32",
"example": 34,
"description": "Indicates if the user still has unread notifications. If the user has unread notifications they can be transfered to another user with access to the same employer",
"readOnly": true
},
"numberOfActiveConnections": {
"type": "integer",
"format": "int32",
"example": 0,
"description": "Indicates if the user still has active connections (connections with externe software by means of an Oauth flow. e.g. Exact online, Twinfield and Accountview connections for journal data). ",
"readOnly": true
},
"numberOfActiveIntegrations": {
"type": "integer",
"format": "int32",
"example": 3,
"description": "Indicates if the user still has active integrations. Integrations are other Oauth clients that by means of the Oauth flow gained access to the loket API. ",
"readOnly": true
},
"numberOfLinkedEmployers": {
"type": "integer",
"format": "int32",
"description": "If a user is linked to multiple employers the user has to be unlinked from all but one employer befor the user can be truly deleted. Both actions have their own endpoint\n* DeleteEmployerUserByUserId * DeleteLinkBetweenEmployerUserAndEmployerByEmployerIdAndUserId",
"example": 3,
"readOnly": true
}
}
},
"authorizationSet-3": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"description": "The authorization set for the user and employer combination. ",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3,
"readOnly": true
},
"value": {
"type": "string",
"example": "Salarisadministrateur",
"maxLength": 50,
"readOnly": true
}
}
},
"allEmployerUsersForAProvider": {
"type": "object",
"properties": {
"employerUser": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"loginMethod": {
"$ref": "#/components/schemas/loginMethod"
},
"personalDetails": {
"type": "object",
"properties": {
"firstName": {
"$ref": "#/components/schemas/firstName-2"
},
"initials": {
"$ref": "#/components/schemas/initials-3"
},
"prefix": {
"$ref": "#/components/schemas/prefix-2"
},
"lastName": {
"$ref": "#/components/schemas/lastName-2"
}
}
},
"contactInformation": {
"$ref": "#/components/schemas/contactInformation-4"
},
"userSpecifiedRole": {
"$ref": "#/components/schemas/userSpecifiedRole"
},
"userCustomSpecifiedRole": {
"$ref": "#/components/schemas/userCustomSpecifiedRole"
},
"hasAccessToPayrollingTestData": {
"$ref": "#/components/schemas/hasAccessToPayrollingTestData"
},
"accessStatus": {
"$ref": "#/components/schemas/accessStatus"
},
"hasMultiFactorAuthentication": {
"$ref": "#/components/schemas/hasMultiFactorAuthentication"
},
"twoFactorAuthenticationRequired": {
"$ref": "#/components/schemas/twoFactorAuthenticationRequired"
},
"azureActiveDirectory": {
"$ref": "#/components/schemas/azureActiveDirectory-2"
},
"userName": {
"$ref": "#/components/schemas/userNameReadOnly"
},
"isDepartmentManager": {
"$ref": "#/components/schemas/isDepartmentManager"
},
"isLinkedToMultipleEmployers": {
"$ref": "#/components/schemas/isLinkedToMultipleEmployers"
},
"hasIntegrations": {
"$ref": "#/components/schemas/hasIntegrations-2"
},
"hasConnectedApplications": {
"$ref": "#/components/schemas/hasConnectedApplications-2"
},
"dateTimeLastLogin": {
"$ref": "#/components/schemas/dateTimeLastLogin"
},
"dateTimeCreation": {
"$ref": "#/components/schemas/dateTimeCreation"
},
"authorizationSet": {
"$ref": "#/components/schemas/authorizationSet-3"
}
}
},
"employer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of the employer",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"companyName": {
"type": "string",
"example": "Voorbeeld B.V.",
"description": "Name of the company",
"maxLength": 70,
"readOnly": false
},
"employerNumber": {
"type": "integer",
"format": "int32",
"example": 20720,
"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).",
"readOnly": true,
"x-loket-db-field": "Loket.Werkgever.WerkgeverId"
},
"providerSettings": {
"type": "object",
"properties": {
"administrationNumber": {
"type": [
"string",
"null"
],
"example": "SR2",
"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.",
"maxLength": 15,
"readOnly": false
},
"groupCode": {
"format": "int32",
"type": [
"integer",
"null"
],
"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,
"readOnly": false
}
}
}
}
}
}
},
"linkedDepartments": {
"type": "object",
"properties": {
"userId": {
"$ref": "#/components/schemas/id"
},
"personalDetails": {
"type": "object",
"properties": {
"firstName": {
"$ref": "#/components/schemas/firstName-2"
},
"initials": {
"$ref": "#/components/schemas/initials-3"
},
"prefix": {
"$ref": "#/components/schemas/prefix-2"
},
"lastName": {
"$ref": "#/components/schemas/lastName-2"
}
}
},
"departments": {
"type": "array",
"items": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"description": "The visible identifier of the department.\n"
},
"description": {
"type": "string",
"example": "Verkoop Binnendienst",
"readOnly": false,
"maxLength": 50,
"description": "The visible description (i.e. name) of the department. \n"
},
"hasAccessToSubDepartments": {
"type": [
"boolean",
"null"
],
"example": false,
"description": "Indicates whether the user will have access to departments that are configured as sub-departments of the selected department.",
"readOnly": true
}
}
}
}
}
},
"linkedDepartmentsPatch": {
"properties": {
"departmentId": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (GUID/UUID) of the department",
"readOnly": false
},
"action": {
"type": "string",
"enum": [
"link",
"unlink"
],
"description": "The action to perform.",
"readOnly": false
},
"hasAccessToSubDepartments": {
"type": "boolean",
"example": false,
"description": "Indicates whether the user will have access to departments that are configured as sub-departments of the selected department.",
"readOnly": false
}
}
},
"notificationSet": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"description": {
"type": "string",
"example": "Salarisadministrateur",
"maxLength": 50,
"readOnly": true
}
}
},
"notification-2": {
"type": "object",
"properties": {
"notificationSet": {
"$ref": "#/components/schemas/notificationSet"
},
"notifications": {
"$ref": "#/components/schemas/notifications-2"
}
}
},
"linkExistingUser": {
"type": "object",
"properties": {
"userId": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"departments": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"format": "uuid",
"description": "id of a department",
"example": "904d6856-6034-4624-bcbc-886188c115c5",
"readOnly": false
}
},
"copyAuthorizationsFromEmployerId": {
"$ref": "#/components/schemas/idNullableEditable"
}
}
},
"recommendedActionsGetAndPut": {
"type": "object",
"properties": {
"rank": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The rank of the recommended action",
"readOnly": true
},
"url": {
"type": "string",
"format": "url",
"example": "{URI}/v2/providers/employers/123/salarisverwerking/starten",
"readOnly": true,
"maxLength": 2048
},
"action": {
"type": [
"object",
"null"
],
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the recommended action",
"readOnly": false
},
"value": {
"type": "string",
"example": "Starten verloning",
"description": "description of the recommended action",
"maxLength": 50,
"readOnly": true
}
}
}
}
},
"linkedEmployeePatch": {
"properties": {
"employeeId": {
"type": [
"string",
"null"
],
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (GUID/UUID) of the department",
"readOnly": false
}
}
},
"userResponsibility": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"description": "name of the user responsibility",
"example": "Payroll profesional",
"minLength": 1,
"maxLength": 70,
"readOnly": false
},
"origin": {
"type": "string",
"enum": [
"System",
"Provider"
],
"description": "Indication if the level on which the record was registerd. System records that cannot be changed in any way.",
"readOnly": true
}
}
},
"userResponsibility-2": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"description": "name of the user responsibility",
"example": "Payroll profesional",
"minLength": 1,
"maxLength": 70,
"readOnly": false
},
"numberOfLinkedUsers": {
"type": "integer",
"format": "int32",
"description": "The number of users linked to this user responsibility for the given employer",
"example": 3,
"readOnly": false
},
"origin": {
"type": "string",
"enum": [
"System",
"Provider"
],
"description": "Indication if the level on which the record was registerd. System records that cannot be changed in any way.",
"readOnly": true
}
}
},
"linkedUsers": {
"type": "array",
"items": {
"properties": {
"id": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"personalDetails": {
"type": "object",
"readOnly": true,
"properties": {
"firstName": {
"$ref": "#/components/schemas/firstName-2"
},
"initials": {
"$ref": "#/components/schemas/initials-3"
},
"prefix": {
"$ref": "#/components/schemas/prefix-2"
},
"lastName": {
"$ref": "#/components/schemas/lastName-2"
}
}
},
"userName": {
"type": [
"string",
"null"
],
"example": "User42",
"maxLength": 50,
"minLength": 3,
"pattern": "^[A-Za-z0-9_.@-]+$",
"description": "The username",
"readOnly": true
},
"isLinked": {
"type": "boolean",
"description": "If true the user is linked to the given responsibility for the given employer\nLink or unlink resposibilty for the user and the given employer.",
"readOnly": false
},
"deviatingHandler": {
"type": [
"object",
"null"
],
"readOnly": false,
"properties": {
"id": {
"$ref": "#/components/schemas/idNullableEditable"
},
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name of the user",
"maxLength": 28,
"minLength": 1,
"readOnly": false
},
"initials": {
"type": "string",
"example": "S.L.",
"pattern": "^[A-Za-zÀ-ÖØ-öø-ÿ]{1,6}$",
"description": "The initials of the user",
"maxLength": 6,
"minLength": 1,
"readOnly": false
},
"prefix": {
"type": [
"string",
"null"
],
"example": "van",
"description": "The prefix of the user",
"maxLength": 10,
"minLength": 1,
"readOnly": false
},
"lastName": {
"type": "string",
"example": "Bergen",
"description": "The last name of the user",
"pattern": "^[A-Za-zÀ-ÖØ-öø-ÿ]{1,25}$",
"maxLength": 25,
"minLength": 1,
"readOnly": false
}
}
}
}
}
},
"linkedUsersPatch": {
"type": "array",
"items": {
"properties": {
"id": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"isLinked": {
"type": "boolean",
"description": "If true the user is linked to the given responsibility for the given employer\nLink or unlink resposibilty for the user and the given employer.",
"readOnly": false
},
"deviatingHandlerId": {
"$ref": "#/components/schemas/idNullableEditable"
}
}
}
},
"userResponsibility-3": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"description": "name of the user responsibility",
"example": "Payroll profesional",
"minLength": 1,
"maxLength": 70,
"readOnly": false
},
"isLinked": {
"type": "boolean",
"description": "If true the user is linked to the given responsibility for the given employer",
"readOnly": false
},
"deviatingHandler": {
"type": [
"object",
"null"
],
"readOnly": false,
"properties": {
"id": {
"$ref": "#/components/schemas/idNullableEditable"
},
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name of the user",
"maxLength": 28,
"minLength": 1,
"readOnly": false
},
"initials": {
"type": "string",
"example": "S.L.",
"pattern": "^[A-Za-zÀ-ÖØ-öø-ÿ]{1,6}$",
"description": "The initials of the user",
"maxLength": 6,
"minLength": 1,
"readOnly": false
},
"prefix": {
"type": [
"string",
"null"
],
"example": "van",
"description": "The prefix of the user",
"maxLength": 10,
"minLength": 1,
"readOnly": false
},
"lastName": {
"type": "string",
"example": "Bergen",
"description": "The last name of the user",
"pattern": "^[A-Za-zÀ-ÖØ-öø-ÿ]{1,25}$",
"maxLength": 25,
"minLength": 1,
"readOnly": false
}
}
}
}
},
"linkedResponsibilities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/idReadOnlyFalse"
},
"isLinked": {
"type": "boolean",
"description": "If true the user is linked to the given responsibility for the given employer",
"readOnly": false
},
"deviatingHandlerId": {
"$ref": "#/components/schemas/idNullableEditable"
}
}
}
},
"licenses": {
"type": "object",
"properties": {
"license": {
"type": [
"object",
"null"
],
"properties": {
"user": {
"properties": {
"userId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"personalDetails": {
"type": "object",
"readOnly": true,
"properties": {
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name of the user",
"maxLength": 28,
"minLength": 1,
"readOnly": true
},
"initials": {
"type": "string",
"example": "S.L.",
"description": "The initials of the user",
"maxLength": 6,
"minLength": 1,
"readOnly": true
},
"prefix": {
"type": [
"string",
"null"
],
"example": "van",
"description": "The prefix of the user",
"maxLength": 10,
"minLength": 1,
"readOnly": true
},
"lastName": {
"type": "string",
"example": "Bergen",
"description": "The last name of the user",
"maxLength": 25,
"minLength": 1,
"readOnly": true
}
}
}
}
}
}
}
}
},
"externalTenantObject": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id",
"readOnly": false
},
"externalId": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": [
"string",
"null"
],
"example": "Loket tenant",
"description": "The user-friendly name of the external tenant",
"maxLength": 28,
"readOnly": true
}
}
},
"configuredExternalTenantObject": {
"type": "object",
"properties": {
"externalTenant": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"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)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"name": {
"type": "string",
"example": "Loket tenant",
"description": "The user-friendly name of the external tenant",
"maxLength": 28,
"readOnly": true
}
}
},
"externalUser": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"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 successfully perform the Azure AD login flow it must correspond with an actual user id within the provided external tenant.",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
}
}
}
}
},
"payslip-2": {
"type": "object",
"x-loket-implementation": "Voor het ophalen van gegevens kan gebruikt worden gemaakt van de bestaande stored procedure DossierVorming.GetLoonstroken. Deze zal uitgebreid moeten worden met DatumIngang en DatumEinde om de velden in payrollPeriod te kunnen vullen.",
"properties": {
"payrollrunId": {
"$ref": "#/components/schemas/id"
},
"payrollPeriod": {
"$ref": "#/components/schemas/payrollPeriod-2"
},
"numberOfPayslips": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 3,
"example": 1,
"description": "The number of different types of payslips for the given payroll period.",
"readOnly": true,
"x-loket-implementation": "Dit veld is een berekende waarde in de stored procedure DossierVorming.GetLoonstroken. Deze stored procedure zal ook gebruikt woren om de gegevens voor deze entiteit op te halen."
},
"approvalTime": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the payslip was approved.",
"readOnly": true,
"x-loket-db-field": "Ulsa.VerloningsRun.DatumAfgehandeld",
"x-loket-implementation": "Deze waarde kan niet nullable zijn omdat er pas een loonstrook beschikbaar is als de verloningsrun is goedgekeurd. Goedgekeurde verloningsruns hebben altijd een DatumAfgehandeld."
}
}
},
"payrollPeriodType-3": {
"type": "object",
"format": "metadata",
"description": "Indicates the frequency of the payrolling process. Payrolling can be done on a monthly (key 1), 4-weekly (key 3) or weekly (key 4) basis.",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true
},
"value": {
"type": "string",
"example": "month",
"maxLength": 50,
"readOnly": true
}
}
},
"employments-2": {
"type": "object",
"properties": {
"employmentId": {
"$ref": "#/components/schemas/id",
"x-loket-implementation": "Loket.Dienstverband.ExternId"
},
"payrollPeriods": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payrollPeriod": {
"type": "object",
"format": "metadata",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period the record relates to",
"example": 2017,
"readOnly": false,
"x-loket-db-field": "Ulsa.LoonaangifteBericht.Jaar"
},
"periodNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "The period number of the payroll period the record relates to",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Ulsa.LoonaangifteBericht.Periode"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period for which the tax return message was created",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period for which the tax return message was created",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"testYear": {
"type": "boolean",
"example": false,
"description": "Indicates whether the payroll periode is part of a test year.\n\nIn 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. \nPlease 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.",
"readOnly": true,
"x-loket-db-field": "af te leiden uit de jaarinrichting van de administratie Ulsa.Jaar"
},
"payrollPeriodType": {
"$ref": "#/components/schemas/payrollPeriodType-3"
}
}
},
"payslipTypes": {
"type": "array",
"minimum": 0,
"items": {
"type": "object",
"properties": {
"payslipType": {
"type": "object",
"format": "metadata",
"description": "The type of payslip on which underlying payroll run results will be booked. This is either normaal or bijzonder tarief.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Strook",
"x-loket-comment": "LET OP; hier gaat het om ulsaCode maar we willen teruggeven de loketCode (zie ctStrook)"
},
"value": {
"type": "string",
"example": "Normaal strook",
"readOnly": true,
"x-loket-db-field": "dbo.ctStrook.Omschrijving"
}
}
},
"payrollComponentResults": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payrollComponent": {
"type": "object",
"format": "metadata",
"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.\n\n`payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Component"
},
"value": {
"type": "string",
"example": "Uren gewerkt",
"description": "The description of the payroll component\n",
"maxLength": 14,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Naam (rekening houden met overerving)"
},
"category": {
"type": "object",
"format": "metadata",
"description": "The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc. \n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Categorie"
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true,
"x-loket-db-field": "dbo.ctCategorie.omschrijving"
}
}
},
"column": {
"type": "object",
"format": "metadata",
"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.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 6,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Kolom",
"x-loket-implementation": "deze waarde kan 0 zijn met een betekenis, dus; niet vertalen naar NULL !"
},
"value": {
"type": "string",
"example": "Sociaalplichtig loon",
"readOnly": true,
"x-loket-db-field": "dbo.ctKolom.omschrijving"
}
}
},
"costsEmployer": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.KostenWerkgever"
},
"value": {
"type": "string",
"example": "+",
"readOnly": true,
"x-loket-db-field": "dbo.ctKostenWerkgever.Omschrijving"
}
}
},
"hoursIndication": {
"type": [
"boolean",
"null"
],
"readOnly": true,
"description": "Only applicable for component in category 6 (eenheden)\n",
"x-loket-db-field": "Ulsa.Component.UrenIndicatie"
},
"countAsNormHours": {
"type": "boolean",
"readOnly": true,
"example": true,
"description": "Indicates whether its value is counted as norm hours (bij bepalen normuren)\n",
"x-loket-db-field": "Ulsa.ComponentAlgemeen.MeetellenVoorNormUren"
}
}
},
"value": {
"type": "number",
"example": 40,
"description": "Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this.",
"readOnly": true,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.Inhoud",
"x-loket-comment": "Maximum precision = 2"
},
"valueSpecialTariff": {
"type": "number",
"example": 144,
"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.",
"readOnly": true,
"x-loket-db-field": "Ulsa.WerknemerLoonresultaatComponent.InhoudTarief",
"x-loket-comment": "Maximum precision = 2"
}
}
}
}
}
}
}
}
}
}
}
},
"yearEndStatement": {
"type": "object",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year for which a year-end statement is available.",
"example": 2018,
"readOnly": true,
"x-loket-implementation": "De bestaande stored procedure Dossiervorming.GetJaaropgaven kan hergebruikt worden om de lijst van jaren waarvoor een jaaropgave bestaat voor het dienstverband"
}
}
},
"payrollTaxReturn": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"payrollTaxReturnStatus": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "The current status of the tax return\nPossible values:\n\n* Verzoek tot aanmaak loonaangifte (key = 1)\n* Fout bij aanmaken loonaangifte (key = 2)\n* Loonaangifte aangemaakt (key = 3)\n* Loonaangifte geannuleerd (key = 4)\n* Loonaangifte bevestigd (key = 5)\n* Loonaangifte verzonden (key = 6)\n* Loonaangifte verwijderd (key = 7)\n",
"x-loket-implementation": "!!! DIT IS EEN NOG NIET BESTAANDE CODETABEL!!! Er is nog geen codetabel met statussen voor een loonaangifte zoals hier ontworpen (combinatie loonaangifteRun en loonaangifteBericht). Na overleg met Maarten Bekkers zijn de volgende statussen voor een loonaangifte bepaald:\n \n - Verzoek tot aanmaak loonaangifte (key = 1)\n Ulsa.LoonAangifteRun.Status heeft status 0 en er is geen record in Ulsa.LoonAangifteBericht\n - Fout bij aanmaken loonaangifte (key = 2)\n Ulsa.LoonAangifteRun.Status heeft status 7 en er is geen record in Ulsa.LoonAangifteBericht\n - Loonaangifte aangemaakt (key = 3)\n Ulsa.LoonAangifteRun.Status heeft status 9 en Ulsa.LoonAangifteBericht.DatumAanmaak is gevuld\n - Loonaangifte geannuleerd (key = 4)\n Ulsa.LoonaangifteRun.Status heef status 8 en er is een record in Ulsa.LoonAangifteBericht met ENKEL het BerichtID veld gevuld\n - Loonaangifte bevestigd (key = 5)\n Ulsa.LoonAangifteRun.Status heeft status 9 en Ulsa.LoonAangifteBericht.DatumGoedkeuring is gevuld\n - Loonaangifte verzonden (key = 6)\n Ulsa.LoonAangifteRun.Status heeft status 9 en Ulsa.LoonAangifteBericht.DatumVerzending is gevuld\n - Loonaangifte verwijderd (key = 7)\n Ulsa.LoonAangifteRun.Status heeft status 9 en Ulsa.LoonAangifteBericht.DatumVerwijderd is gevuld\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3
},
"value": {
"type": "string",
"example": "Loonaangifte aangemaakt"
}
}
},
"period": {
"type": "object",
"format": "metadata",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the period for which the tax return message was created.",
"example": 2017,
"readOnly": true
},
"periodNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"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,
"readOnly": true
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period for which the tax return message was created",
"example": "2018-01-01",
"readOnly": true
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period for which the tax return message was created",
"example": "2018-01-31",
"readOnly": true
}
}
},
"periodAmount": {
"type": "number",
"description": "The amount, in euro's, of wage tax to be paid for this period",
"example": 2000,
"readOnly": true,
"x-loket-db-field": "Ulsa.LoonAangifteTijdvak.TotaalTijdvak",
"x-loket-implementation": "Zie de stored procedure Ulsa.prcLoonAangifteBerichtSelect voor de join tussen Ulsa.LoonAangifteBericht en Ulsa.LoonAangifteTijdvak."
},
"correctionAmount": {
"type": "number",
"description": "The amount, in euro's, of wage tax to be paid as correction for previous period(s)",
"example": 500,
"readOnly": true,
"x-loket-implementation": "Dit is in Loket 2 een computed column in de dataset. In de API kunnen we dit dus ook op de zelfde manier berekenen. De waarde wordt berekend door de formule: TotaalAangifte - TotaalTijdvak. Deze berekening komt uit DataSetLoonAangifteBericht in Loket.Core."
},
"totalAmount": {
"type": "number",
"description": "The cumulative ammount of the correctionAmount and periodAmount. Indication the total ammount to be paid for this wagetax return",
"example": 2500,
"readOnly": true,
"x-loket-db-field": "Ulsa.LoonAangifteTijdvak.TotaalAangifte",
"x-loket-implementation": "Zie de stored procedure Ulsa.prcLoonAangifteBerichtSelect voor de join tussen Ulsa.LoonAangifteBericht en Ulsa.LoonAangifteTijdvak."
},
"paymentReference": {
"type": "string",
"description": "The payment reference (betalingskenmerk) to be used when making the payment to the tax office.",
"example": "8111111116529080",
"readOnly": true,
"x-loket-db-field": "Ulsa.LoonAangifteBericht.Betalingskenmerk"
},
"messageReference": {
"type": "string",
"description": "The message reference (berichtkenmerk) that is used within the payroll tax return message.\n",
"example": "VSP001111111110L29000035201302",
"readOnly": true,
"x-loket-db-field": "Ulsa.LoonAangifteBericht.BerichtKenmerk"
},
"iban": {
"type": "string",
"description": "The IBAN to which the payroll tax return should be payed. Only IBAN without spaces are accepted.",
"example": "NL86INGB0000000000",
"readOnly": true,
"x-loket-implementation": "Deze waarde staat hardcoded in de stored procedure Ulsa.prcLoonAangifteBerichtSelect. Als de deze stored procedure niet gaan gebruiken voor de interne service, dan zullen we deze waarde dus moeten hardcoden in de interne service."
},
"inTheNameOf": {
"type": "string",
"description": "The name of the benificiary corresponding with the IBAN",
"example": "tnv belastingdienst Apeldoorn",
"readOnly": true,
"x-loket-implementation": "Deze waarde staat hardcoded in de stored procedure Ulsa.prcLoonAangifteBerichtSelect. Als de deze stored procedure niet gaan gebruiken voor de interne service, dan zullen we deze waarde dus moeten hardcoden in de interne service."
},
"isCorrectionMessagePriorYear": {
"type": "boolean",
"example": true,
"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. \n",
"readOnly": false
},
"wageTaxNumber": {
"type": "string",
"description": "The wage tax number aka Loonheffingennummer.",
"maxLength": 12,
"example": "111111110L00",
"readOnly": true
},
"sequenceNumber": {
"type": "integer",
"format": "int32",
"description": "An incremental number.",
"example": 1,
"readOnly": true
},
"methodOfCreation": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The key indicating how the payroll tax return run was created.",
"readOnly": true
},
"value": {
"type": "string",
"example": "Individueel",
"description": "The value describing how the payroll tax return run was created.",
"readOnly": true
}
}
},
"requestTime": {
"type": "string",
"format": "date-time",
"example": "2021-05-08T15:16:49+02:00",
"description": "The time at which the payroll tax return run was requested by the user",
"readOnly": true
},
"requestedBy": {
"$ref": "#/components/schemas/userBasicNotNullable"
},
"processingFinishedTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2021-05-08T15:16:49+02:00",
"description": "Date-time when the calculations were finished",
"readOnly": true
},
"cancelledTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The time at which the pay roll run was cancelled. (Annuleren)",
"example": "2021-05-08T15:16:49+02:00",
"readOnly": true
},
"cancelledBy": {
"$ref": "#/components/schemas/userBasic"
},
"taxReturnMessageReference": {
"type": [
"string",
"null"
],
"example": "Bedrijf B.V.",
"description": "The name of the party responsible for the payroll tax return",
"readOnly": true
},
"withholdingParty": {
"type": [
"string",
"null"
],
"example": "Bedrijf B.V.",
"description": "The name of the party responsible for the payroll tax return",
"readOnly": true
},
"messageCreationTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2021-05-08T15:16:49+02:00",
"description": "Date-time when the message was created",
"readOnly": true
},
"payrollPeriodType": {
"type": "object",
"readOnly": true,
"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).",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.code"
},
"value": {
"type": "string",
"example": "month",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.omschrijving"
}
}
},
"payrollTaxReturnType": {
"type": "object",
"readOnly": true,
"description": "Indicates the frequence of the payrol tax retun process. Can be each payroll period or annually.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortLoonaangifte.code"
},
"value": {
"type": "string",
"example": "Periodeaangifte",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortLoonaangifte.omschrijving"
}
}
},
"payrollTaxReturnParty": {
"type": "object",
"readOnly": true,
"description": "Indicates the party submitting the tax return.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "dbo.ctExternePartijLoonaangifte.code"
},
"value": {
"type": "string",
"example": "Loket.nl",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctExternePartijLoonaangifte.omschrijving"
}
}
},
"externalIdentification": {
"type": [
"string",
"null"
],
"example": "AA123",
"description": "An identifier to be filled by external parties after submitting the tax return.",
"readOnly": true
},
"approvalTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2021-05-08T15:16:49+02:00",
"description": "The time at which the payroll tax return run was approved by the user",
"readOnly": true
},
"approvedBy": {
"$ref": "#/components/schemas/userBasic"
},
"sendTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2021-05-08T15:16:49+02:00",
"description": "The time at which the payroll tax return run message was send.",
"readOnly": true
},
"removalTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2021-05-08T15:16:49+02:00",
"description": "The time at which the payroll tax return run was removed (verwijderd by the user",
"readOnly": true
},
"removedBy": {
"$ref": "#/components/schemas/userBasic"
},
"emailAddressPayrollTaxReturnRunStarted": {
"type": [
"string",
"null"
],
"example": "info@loket.nl",
"description": "The e-mail address to which an email will be sent when the payroll tax return run is started. (Email starten)",
"readOnly": true
},
"deadlineForPayment": {
"type": "string",
"format": "date",
"example": "2021-12-31",
"description": "The final date at which the amount is due.",
"readOnly": true
},
"canBeResend": {
"type": "boolean",
"example": true,
"description": "Indicates whether the payroll tax return can be resend to the tax authorities. \n",
"readOnly": true
},
"initiateIdealPayment": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "Indicates whether the payroll tax can be payed by means of IDEAL.\nPossible values:\n- Ideal Payment is possible (key = 0)\n- Ideal Payment not possible for total amount (<=0 of >=50.000) (key = 1)\n- Ideal Payment not possible from a \"G-rekening\" (key = 2)\n- Ideal Payment not possible there is a pending payment (key = 3)\n- Ideal Payment not possible the payment has already been processed and accepted (key = 4) \n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 0,
"readOnly": true
},
"value": {
"type": "string",
"example": "Ideal Payment is possible",
"readOnly": true
}
}
},
"responseMessages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dateOfReceipt": {
"type": "string",
"format": "date",
"example": "2016-01-19",
"description": "The date on which the response message was received",
"readOnly": true
},
"responseType": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "The response type",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2
},
"value": {
"type": "string",
"example": "Error"
}
}
},
"responseClass": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "The Walvis class code",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 26
},
"value": {
"type": "string",
"example": "Loonheffingennummer is onjuist"
}
}
}
}
}
}
}
},
"payrollTaxReturnPatch": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"action": {
"type": "string",
"enum": [
"confirm",
"cancel"
],
"description": "The action to perform on the payroll tax return",
"readOnly": false
}
},
"required": [
"id",
"action"
]
},
"sepaHash": {
"type": "object",
"properties": {
"hash": {
"type": "string",
"description": "The SHA-256 hash",
"pattern": "^[a-f0-9]{64}$",
"example": "cd2feea250047d4477a0276f864e9c223af66a73c305f872c31dc0cdfb709b1f",
"readOnly": true
}
}
},
"idealLink": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "url",
"example": "https://betalen.belastingdienst.nl/kas/ideal_betaling?id=1700&code=1easdasasdasdasdasdasd5",
"description": "The URL leads to the IDEAL payment environment of the dutch payroll tax authorities (belastingdienst).",
"readOnly": true
}
}
},
"idealStatus": {
"type": "object",
"properties": {
"status": {
"type": [
"object",
"null"
],
"properties": {
"code": {
"type": "string",
"example": "acsc",
"description": "The status code (as defined by the Dutch tax authorities) of the IDEAL payment",
"readOnly": true
},
"reason": {
"type": "string",
"example": "accepted",
"description": "The reason for the given status code of the IDEAL payment",
"readOnly": true
}
}
},
"lastStatusRequest": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The date time on which the last **successful** status request was performed",
"readOnly": true
}
}
},
"payrollTaxReturnSinglePatch": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"confirm",
"cancel"
],
"description": "The action to perform on the payroll tax return",
"readOnly": false
}
},
"required": [
"action"
]
},
"initiationParametersNew": {
"type": "object",
"properties": {
"notifyOfInitiation": {
"type": [
"string",
"null"
],
"example": "info@loket.nl",
"description": "The email adres to notify when a new payroll tax return is started",
"maxLength": 255,
"readOnly": false
},
"payrollPeriod": {
"type": "object",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period the request relates to",
"example": 2024,
"readOnly": false
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period number of the payroll period the request relates to",
"example": 1,
"readOnly": false
}
}
}
}
},
"initiationParameters": {
"type": "object",
"properties": {
"notifyOfInitiation": {
"type": [
"string",
"null"
],
"example": "info@loket.nl",
"description": "The email adres to notify when a new payroll tax return is started",
"maxLength": 255,
"readOnly": false
}
}
},
"initiatedPayrollTaxReturnRun": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (GUID/UUID) of the payroll tax return run.",
"readOnly": false
}
}
},
"initiationParametersForPreviousPayrollYear": {
"type": "object",
"properties": {
"notifyOfInitiation": {
"type": [
"string",
"null"
],
"example": "info@loket.nl",
"description": "The emial adres to notify when a new payroll tax return is started",
"maxLength": 255,
"readOnly": false
},
"payrollYear": {
"type": "string",
"example": 2022,
"readOnly": false
}
}
},
"payrollTaxReturnCollective": {
"properties": {
"payrollAdministrationId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
}
}
},
"withdrawParameters": {
"type": "object",
"properties": {
"citizenServiceNumber": {
"$ref": "#/components/schemas/citizenServiceNumber"
},
"payrollId": {
"type": "integer",
"format": "int32",
"example": 2,
"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.",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.PersoneelsnummerVerloning"
},
"incomeRelationshipNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"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.",
"minimum": 0,
"maximum": 9999,
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.NummerInkomstenVerhouding"
},
"addWithdrawalTo": {
"type": "object",
"format": "metadata",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period the record relates to",
"example": 2017,
"readOnly": false,
"x-loket-db-field": "Ulsa.LoonaangifteBericht.Jaar"
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period number of the payroll period the record relates to",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Ulsa.LoonaangifteBericht.Periode"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period for which the tax return message was created",
"example": "2018-01-01",
"readOnly": true,
"x-loket-db-field": null,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period for which the tax return message was created",
"example": "2018-01-31",
"readOnly": true,
"x-loket-db-field": null,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"testYear": {
"type": "boolean",
"example": false,
"description": "Indicates whether the payroll periode is part of a test year.\n\nIn 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. \nPlease 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.",
"readOnly": true,
"x-loket-db-field": "af te leiden uit de jaarinrichting van de administratie Ulsa.Jaar"
}
}
}
}
},
"province": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "A Dutch province",
"properties": {
"key": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1,
"description": "The key for the province. Possible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "Provincie"
},
"value": {
"type": [
"string",
"null"
],
"example": "Noord-Holland",
"description": "The name of the province. Only the Dutch provices are supported and not translated",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctProvincie.Omschrijving"
}
}
},
"address-4": {
"properties": {
"postalCode": {
"$ref": "#/components/schemas/postalCode"
},
"houseNumber": {
"$ref": "#/components/schemas/houseNumber"
},
"street": {
"$ref": "#/components/schemas/street"
},
"city": {
"$ref": "#/components/schemas/city"
},
"province": {
"$ref": "#/components/schemas/province",
"x-loket-implementation": "we verwachten hier de de Loket key-value waarmee te putten is"
},
"coordinates": {
"type": [
"object",
"null"
],
"readOnly": true,
"properties": {
"latitude": {
"type": "number",
"example": 51.62132245,
"description": "Lattitude of the location",
"readOnly": true
},
"longitude": {
"type": "number",
"example": 5.55417593,
"description": "Longitude of the location",
"readOnly": true
}
}
}
}
},
"addressObject": {
"type": "object",
"properties": {
"pointOfInterest": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"type": "string",
"example": "Van Spaendonck Groep",
"description": "The name of the point of interest",
"readOnly": true
}
}
},
"address": {
"type": [
"object",
"null"
],
"properties": {
"freeformAddress": {
"type": "string",
"description": "description of the address",
"example": "Reitseplein 1, 5037 AA Tilburg",
"maxLength": 1000,
"readOnly": true
},
"countryCode": {
"type": "string",
"example": "NL",
"description": "isocode of the country",
"readOnly": true
}
}
},
"position": {
"type": "object",
"properties": {
"latitude": {
"description": "latitude for the address",
"example": 51.585996,
"type": "number",
"format": "double",
"minimum": -90,
"maximum": 90
},
"longitude": {
"description": "longitude for the address",
"example": 5.585996,
"type": "number",
"format": "double",
"minimum": -180,
"maximum": 180
}
}
}
}
},
"routeObject": {
"type": "object",
"properties": {
"routeType": {
"type": "string",
"enum": [
"Fastest",
"Shortest"
],
"description": "The method used to calculate the route",
"readOnly": true
},
"lengthInKilometers": {
"type": "number",
"format": "double",
"description": "Total length of the route",
"example": 48.87,
"readOnly": true
}
}
},
"aowDate": {
"type": [
"object",
"null"
],
"properties": {
"aowDate": {
"type": "string",
"format": "date",
"example": "2062-08-21",
"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.",
"readOnly": true
}
}
},
"companyInformation": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"type": [
"string",
"null"
],
"example": "Bedrijf B.V.",
"description": "The company name",
"maxLength": 255,
"readOnly": false
},
"sbi": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The 'Standard Industrial Classifications (Dutch SBI 2008, NACE and ISIC)' as defined bij the Dutch chamber of commerce",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 12,
"description": "The key of the SBI code. Possible values can be aquired via the metadata endpoint",
"readOnly": false
},
"value": {
"type": "string",
"example": "Agriculture, Forestry and Fishing",
"description": "Description of the SBI code",
"readOnly": true,
"maxLength": 255,
"x-loket-db-field": "dbo.ctSbi"
},
"sbiCode": {
"type": "string",
"example": "0116",
"description": "Possible values are the values from the Dutch SBI 2008",
"readOnly": true,
"maxLength": 32
}
}
},
"legalForm": {
"type": [
"object",
"null"
],
"format": "metadata",
"x-loket-implementation": "0 in database wordt NULL in resource",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the legal form. Possible values can be aquired via the metadata endpoint",
"readOnly": false
},
"value": {
"type": "string",
"example": "B.V.",
"description": "Description of the legal form. Possible values are the legel forms supported by Dutch law",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctrechtsvorm"
}
}
},
"website": {
"type": [
"string",
"null"
],
"format": "url",
"example": "www.voorbeeldbv.nl",
"description": "The website of the employer",
"maxLength": 255,
"readOnly": false
},
"address": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "Voordijk",
"description": "Streetname of the address",
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "Straatnaam"
},
"city": {
"type": "string",
"example": "Leiden",
"maxLength": 24,
"description": "City of the address",
"readOnly": false,
"x-loket-db-field": "Plaatsnaam"
},
"houseNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"description": "House number of the address",
"readOnly": false,
"x-loket-db-field": "Huisnummer"
},
"houseNumberAddition": {
"type": [
"string",
"null"
],
"example": "D",
"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.",
"maxLength": 4,
"readOnly": false,
"x-loket-db-field": "Huisnummertoevoeging"
},
"postalCode": {
"type": "string",
"example": "1234AA",
"description": "The postal code of the address",
"maxLength": 9,
"readOnly": false,
"x-loket-db-field": "Postcode"
},
"country": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the country. Possible values can be aquired via the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "Land"
},
"value": {
"type": "string",
"example": "Netherlands",
"description": "The name of the country",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.Omschrijving"
},
"isoCode": {
"type": "string",
"example": "NL",
"description": "The ISO 3166-1 alpha-2 value for the country",
"maxLength": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.IsoCode"
}
}
}
}
},
"deviatingPostalAddress": {
"type": [
"object",
"null"
],
"properties": {
"street": {
"type": [
"string",
"null"
],
"example": "Voordijk",
"description": "Streetname of the address",
"maxLength": 24,
"readOnly": false,
"x-loket-db-field": "StraatnaamAfwijkend"
},
"city": {
"type": "string",
"example": "Leiden",
"maxLength": 24,
"description": "City of the address",
"readOnly": false,
"x-loket-db-field": "PlaatsnaamAfwijkend"
},
"houseNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 12,
"description": "House number of the address. Filled when poBox is empty.",
"readOnly": false,
"x-loket-db-field": "HuisnummerAfwijkend"
},
"houseNumberAddition": {
"type": [
"string",
"null"
],
"example": "D",
"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.",
"maxLength": 4,
"readOnly": false,
"x-loket-db-field": "HuisnummertoevoegingAfwijkend"
},
"postalCode": {
"type": "string",
"example": "1234 AA",
"description": "The postal code of the address, only nullable if country is not The Netherlands (NL).",
"minLength": 1,
"maxLength": 9,
"readOnly": false,
"x-loket-db-field": "PostcodeAfwijkend",
"x-loket-implementation": "Indien land = NL moet de postcode aan de regex van NL voldoen (9999 aa)"
},
"country": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for the country. Possible values can be aquired by the metadata endpoint",
"readOnly": false,
"x-loket-db-field": "LandAfwijkend"
},
"value": {
"type": "string",
"example": "Netherlands",
"description": "The name of the country",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.Omschrijving"
},
"isoCode": {
"type": "string",
"example": "NL",
"description": "The ISO 3166-1 alpha-2 value for the country",
"maxLength": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctLand.IsoCode"
}
}
},
"poBox": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 5000,
"description": "Post office box",
"readOnly": false,
"x-loket-db-field": "PostbusAfwijkend"
}
}
}
}
},
"dnbObject": {
"type": "object",
"properties": {
"dataNewBusinessToken": {
"type": "string",
"format": "url",
"example": "tKcYuqJtbo7Q0wBzRzDFN6mnDghfJfvMOLMj0mOj9W1EW0wk9k8bWmRLug-AprELWHqHIc9f7Q6rNQQ6U6MNDGvVkxcnZH62FCebdqPhquBUEI1q24eCiqsT3Vn8eC27sX5phOhgHK9_bP2lLnDbqZoo5Li7bKmpS75S0_U7SO_BLyl6p-5jJHV2ZS0XFzjEkwIYkW3rPq41nDmbpuh1kNOyxa1fRbfmGhVJnGmWsQBxPwwypC30wFPUcNHHIBXlrryAXESR5Kal8gOolC5n09FlBFKW2EnCDyC-Wl2I0j95MZTUXwr-5JqiOQNWsILLE0GVW5EPmfvXo7hIRhpi1nl-XyWgHEl6wah9mW0G2sVXnbD0oBfMbFSBXTTcZpsVo3yTJB",
"description": "The access token for calling the Data New Business (DNB) API.",
"readOnly": true
},
"expiresIn": {
"type": "integer",
"format": "int32",
"example": 3600,
"description": "The number of seconds until the token expires.",
"readOnly": true
}
}
},
"functions": {
"properties": {
"functionName": {
"type": "string",
"example": "architect",
"description": "A function name in Dutch\n",
"readOnly": true,
"x-loket-implementation": "De waardes komen uit de DNB API via het endpoint /functies van hun API."
}
}
},
"employment-3": {
"x-loket-implementation": "de dienstverband wordt altijd getoond in deze lijst indien deze tenminste 1 van de dagen van de opgegeven periode in dienst is bij de werkgever (het kan zijn dat deze vervolgens geen beschikbare uren heeft)",
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"incomeRelationshipNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"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.",
"minimum": 0,
"maximum": 9999,
"readOnly": true,
"x-loket-db-field": "Loket.Dienstverband.NummerInkomstenVerhouding"
}
}
},
"employee-3": {
"type": "object",
"readOnly": true,
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"formattedName": {
"type": "string",
"example": "Wiel - van Bergen S.L. van de",
"description": "Formatted name of the employee based on the value of `howToFormatLastName`",
"maxLength": 82,
"readOnly": true,
"x-loket-implementation": "Dit veld is een samenvoegsel van de losse naam elementen. De logica voor het opbouwen van de naam is gelijk aan de logica in Loket.vwVolledigeNaam"
},
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name, given name, forename or Christian name as part of a persons personal name.\n",
"minLength": 1,
"maxLength": 28,
"readOnly": false,
"x-loket-db-field": "Loket.Persoon.Roepnaam"
}
}
},
"department-2": {
"type": "object",
"format": "metadata",
"description": "The department of the employment.\n`department` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true,
"x-loket-db-field": "loket.WerknemerFunctie.Afdeling omzetten naar guid"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.Afdeling.code"
},
"description": {
"type": "string",
"example": "Verkoop",
"readOnly": true,
"x-loket-db-field": "Loket.Afdeling.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.Afdeling bevat de afdelingen voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
},
"employerCalendarAvailability": {
"type": "object",
"properties": {
"employment": {
"$ref": "#/components/schemas/employment-3"
},
"employee": {
"$ref": "#/components/schemas/employee-3"
},
"department": {
"$ref": "#/components/schemas/department-2"
},
"calendar": {
"type": "array",
"description": "A list of time periods for which availability information is available.\n",
"items": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"format": "date",
"example": "2019-01-01",
"description": "The first day of the period for which availability information is available.\n",
"readOnly": true
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2019-01-05",
"description": "The last day of the period for which availability information is available.\n",
"readOnly": true
},
"details": {
"type": [
"object",
"null"
],
"description": "In the future this object describes the calendar item in more detail. For now this object will always be NULL.\n",
"readOnly": true
}
}
}
}
}
},
"employerCalendarLeave": {
"type": "object",
"properties": {
"employment": {
"$ref": "#/components/schemas/employment-3"
},
"employee": {
"$ref": "#/components/schemas/employee-3"
},
"department": {
"$ref": "#/components/schemas/department-2"
},
"calendar": {
"type": "array",
"description": "A list of time periods for which leave information is available.\n",
"items": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"format": "date",
"example": "2019-01-01",
"description": "The first day of the period for which leave information is available.\n",
"readOnly": true
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2019-01-05",
"description": "The last day of the period for which leave information is available.\n",
"readOnly": true
},
"details": {
"type": [
"object",
"null"
],
"description": "In the future this object describes the calendar item in more detail. For now this object will always be NULL.\n",
"readOnly": true
}
}
}
}
}
},
"employerCalendarLeaveRequest": {
"type": "object",
"properties": {
"employment": {
"$ref": "#/components/schemas/employment-3"
},
"employee": {
"$ref": "#/components/schemas/employee-3"
},
"department": {
"$ref": "#/components/schemas/department-2"
},
"calendar": {
"type": "array",
"description": "A list of time periods for which leave request information is available.\n",
"items": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"format": "date",
"example": "2019-01-01",
"description": "The first day of the period for which leave request information is available.\n",
"readOnly": true
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2019-01-05",
"description": "The last day of the period for which leave request information is available.\n",
"readOnly": true
},
"details": {
"type": [
"object",
"null"
],
"description": "In the future this object describes the calendar item in more detail. For now this object will always be NULL.\n",
"readOnly": true
}
}
}
}
}
},
"employerCalendarAbsence": {
"type": "object",
"properties": {
"employment": {
"$ref": "#/components/schemas/employment-3"
},
"employee": {
"$ref": "#/components/schemas/employee-3"
},
"department": {
"$ref": "#/components/schemas/department-2"
},
"calendar": {
"type": "array",
"description": "A list of time periods for which absence information is available.\n",
"items": {
"type": [
"object",
"null"
],
"properties": {
"startDate": {
"type": "string",
"format": "date",
"example": "2019-01-01",
"description": "The first day of the period for which absence information is available.\n",
"readOnly": true
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2019-01-05",
"description": "The last day of the period for which absence information is available.\n",
"readOnly": true
},
"details": {
"type": [
"object",
"null"
],
"description": "In the future this object describes the calendar item in more detail. For now this object will always be NULL.\n",
"readOnly": true
}
}
}
}
}
},
"leaveCalendar": {
"type": "object",
"properties": {
"employeeName": {
"type": "string",
"example": "Wiel van Bergen",
"description": "name of the employee",
"readOnly": true
},
"employmentId": {
"$ref": "#/components/schemas/id"
},
"dates": {
"type": "array",
"items": {
"properties": {
"date": {
"type": "string",
"format": "date",
"example": "2018-04-26",
"description": "The date",
"readOnly": true
},
"leaveStatus": {
"type": [
"string",
"null"
],
"format": "string",
"enum": [
"Approved",
"Requested",
"RevokeRequested"
],
"readOnly": true
},
"nonWorkday": {
"type": [
"boolean",
"null"
],
"description": "Indicates if the day is a workday for the employment",
"readOnly": true
},
"noAccess": {
"type": "boolean",
"description": "Indicates if the day is a workday for the employment",
"readOnly": true
}
}
}
},
"leave": {
"type": [
"array",
"null"
],
"items": {
"properties": {
"status": {
"format": "string",
"enum": [
"Approved",
"Requested",
"RevokeRequested"
]
},
"startDate": {
"type": "string",
"format": "date",
"example": "2018-04-26",
"description": "The date on which the leave starts.",
"readOnly": true
},
"endDate": {
"type": "string",
"format": "date",
"example": "2024-04-29",
"description": "The date on which the leave ends.",
"readOnly": true
}
}
}
}
}
},
"employmentTemplates": {
"type": "object",
"description": "The aggregated employment templates",
"x-loket-db-field": "Loket Loket.Conceptwerknemer WAAR CONCEPTWERKNEMERTYPE = 2 (SJABLOON)!!!",
"readOnly": true,
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"templateName": {
"type": "string",
"example": "Sjabloon voor Oproepkracht",
"minLength": 1,
"maxLength": 255,
"description": "Name of the template",
"readOnly": false,
"x-loket-db-field": "Loket.Conceptwerknemer.UniekeNaam"
},
"employmentData": {
"$ref": "#/components/schemas/employment"
},
"workingHoursData": {
"$ref": "#/components/schemas/workingHours"
},
"wageData": {
"$ref": "#/components/schemas/wage"
},
"organizationalEntityData": {
"$ref": "#/components/schemas/organizationalEntity"
},
"socialSecurityData": {
"$ref": "#/components/schemas/socialSecurity"
},
"fiscalData": {
"$ref": "#/components/schemas/fiscal"
},
"otherPayrollVariablesData": {
"$ref": "#/components/schemas/otherPayrollVariables"
}
}
},
"employmentInformation": {
"type": "object",
"readOnly": true,
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 156,
"minimum": 1,
"description": "The employee number to uniquely identify an employee within an employer\n",
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.Personeelsnummer"
},
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name, given name, forename or Christian name as part of a persons personal name.\n",
"minLength": 1,
"maxLength": 28,
"readOnly": true,
"x-loket-db-field": "Loket.(Persoon/Partner/Kind).Roepnaam"
},
"formattedName": {
"type": "string",
"example": "Wiel - van Bergen S.L. van de",
"description": "Formatted name of the employee based on the value of `howToFormatLastName`",
"maxLength": 82,
"readOnly": true,
"x-loket-implementation": "Dit veld is een samenvoegsel van de losse naam elementen. De logica voor het opbouwen van de naam is gelijk aan de logica in Loket.vwVolledigeNaam"
},
"incomeRelationshipNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"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.",
"minimum": 0,
"maximum": 9999,
"readOnly": true,
"x-loket-db-field": "Loket.Dienstverband.NummerInkomstenVerhouding"
},
"photo": {
"type": [
"string",
"null"
],
"format": "url",
"example": "https://api.loket.nl/v2/v2/providers/employers/employees/{employeeId}/photo/{version}",
"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.",
"readOnly": true
},
"payrollAdministration": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"description": "Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time)\n\n`payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true,
"x-loket-implementation": "Komt uit ulsa.werkgever ipv loket.verloning"
},
"name": {
"type": "string",
"example": "ABC accountants",
"description": "Name of the payroll administration",
"maxLength": 70,
"readOnly": true,
"x-loket-db-field": "Ulsa.Werkgever.Naam --> Dit is anders als wat we nu doen nu komt de naam uit loket.verloning.Omschrijving"
},
"clientNumber": {
"type": "integer",
"format": "int32",
"example": 1234,
"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.",
"readOnly": true,
"x-loket-db-field": "Ulsa.Werkgever.ClientNummer & Loket.Verloning.ClientNr",
"x-loket-implementation": "Het clientnummer is de verbinding tussen Ulsa.Werkgever en Loket.Verloning. Een waarde 0 in de database wordt als NULL teruggegeven in de API."
},
"description": {
"type": "string",
"example": "Bakker",
"description": "Description of the administration",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.Verloning.Omschrijving"
}
}
},
"function": {
"type": "object",
"format": "metadata",
"description": "The function of the employment.\n\n`function` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true,
"x-loket-db-field": "loket.WerknemerFunctie.FunctieID en dan in loket.functie het externId ophalen"
},
"description": {
"type": "string",
"example": "Directeur",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.Functie.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.Functie bevat de functies voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
},
"group": {
"type": [
"string",
"null"
],
"example": "internal",
"maxLength": 5,
"readOnly": true,
"x-loket-db-field": "Loket.Functie.functiegroup",
"x-loket-implementation": "Let op: de tabel Loket.Functie bevat de functies voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
},
"department": {
"x-loket-implementation": "kijk naar organisatorische eenheid regel met grootste startdatum",
"type": "object",
"format": "metadata",
"description": "The department of the employment.\n\n`department` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true,
"x-loket-db-field": "loket.WerknemerFunctie.Afdeling omzetten naar guid"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.Afdeling.code"
},
"description": {
"type": "string",
"example": "Verkoop",
"readOnly": true,
"x-loket-db-field": "Loket.Afdeling.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.Afdeling bevat de afdelingen voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
}
}
},
"declarationComment": {
"type": [
"string",
"null"
],
"description": "The comment left by the employee",
"example": "Overwerk project X",
"maxLength": 1000,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerMutatie.Omschrijving",
"x-loket-implementation": "Een lege string in de database wordt in de API teruggegeven als NULL."
},
"declarationStatus": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "The current status of the declaration\n\nThe status is changed by using the PATCH endpoint.\n1 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",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Loket.WerknemerMutatie.Status"
},
"value": {
"type": "string",
"example": "Open",
"readOnly": true,
"x-loket-db-field": "dbo.ctWerknemerMutatieStatus.Omschrijving"
}
}
},
"dateOfSubmissionByEmployee": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time the declaration was submitted",
"readOnly": true,
"x-loket-db-field": "Loket.WerknemerMutatie.DatumAangemaakt"
},
"dateOfLastChangeByEmployee": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time the declaration was last changed",
"readOnly": true,
"x-loket-db-field": "Loket.WerknemerMutatie.LaatstBijgewerktDoorWerknemer"
},
"processedInPayrollPeriod": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "If the declaration has been successfully processed then this object will show the payroll period for which a payrollPeriodData has been created.\n\nIf the declaration has not yet been processed, then the value of this object will be null.\n",
"readOnly": true,
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period\n",
"example": 2017,
"minimum": 2000,
"maximum": 9999,
"readOnly": true
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period\n",
"example": 1,
"minimum": 1,
"maximum": 53,
"readOnly": true,
"x-loket-db-field": "Laatste 2 cijfers van Loket.WerknemerMutatie.PeriodeID",
"x-loket-implementation": "Bij het updaten/inserten van dit veld eventueel een leading 0 toevoegen aan het periodenummer als deze kleiner is dan 10. Zodat PeriodeID in de database altijd 6 cijfers bevat met als formatting yyyymm, bijvoorbeeld 201807"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period\n",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period\n",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
}
}
},
"declarationObject-2": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"employmentInformation": {
"$ref": "#/components/schemas/employmentInformation"
},
"payrollComponent": {
"$ref": "#/components/schemas/payrollComponent"
},
"calculatedDistanceByRoutingService": {
"$ref": "#/components/schemas/calculatedDistanceByRoutingService"
},
"numberOfUnits": {
"$ref": "#/components/schemas/numberOfUnits"
},
"numberOfUnitsByAnalysis": {
"$ref": "#/components/schemas/numberOfUnitsByAnalysis"
},
"declarationDate": {
"$ref": "#/components/schemas/declarationDate"
},
"declarationComment": {
"$ref": "#/components/schemas/declarationComment"
},
"declarationStatus": {
"$ref": "#/components/schemas/declarationStatus"
},
"dateOfSubmissionByEmployee": {
"$ref": "#/components/schemas/dateOfSubmissionByEmployee"
},
"dateOfLastChangeByEmployee": {
"$ref": "#/components/schemas/dateOfLastChangeByEmployee"
},
"processedInPayrollPeriod": {
"$ref": "#/components/schemas/processedInPayrollPeriod"
},
"reasonForDeviatingFromCalculatedDistance": {
"$ref": "#/components/schemas/reasonForDeviatingFromCalculatedDistance"
},
"route": {
"$ref": "#/components/schemas/route"
}
}
},
"declarationsPatchObject": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (a GUID/UUID)",
"readOnly": false
},
"action": {
"type": "string",
"enum": [
"accept",
"reject"
],
"description": "The action to perform on the declaration resulting in a change of `declarationStatus`\nThe following transitions are allowed\n\n1. Open --> Accept or reject\n2. Goedgekeurd ---> Process\n3. Geweigerd ---> No changes possible\n5. Verwerkt ---> No changes possible\n6. Onverwerkbaar ---> No changes possible",
"readOnly": false
}
},
"required": [
"id",
"action"
]
},
"declarationsProcessPatchObject": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (a GUID/UUID)",
"readOnly": false
},
"payrollPeriodId": {
"type": "integer",
"format": "int32",
"description": "The year and period of the payroll period\n",
"example": 202004,
"readOnly": false
}
},
"required": [
"id",
"payrollPeriodId"
]
},
"declarationAttachmentObject": {
"properties": {
"declarationId": {
"$ref": "#/components/schemas/id"
}
}
},
"declarationIds": {
"properties": {
"declarationId": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (a GUID/UUID)",
"readOnly": false
}
}
},
"performCalculation": {
"type": "object",
"properties": {
"payrollPeriod": {
"type": "object",
"format": "metadata",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period\n",
"example": 2017,
"minimum": 2000,
"maximum": 9999,
"readOnly": false
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period.\n",
"example": 1,
"minimum": 1,
"maximum": 53,
"readOnly": false
}
}
},
"setHoursWorked": {
"type": "boolean",
"example": false,
"description": "Berekenen uren. Sets hours worked-related component(s) in the payroll period data based on the configuration of the employment.",
"readOnly": false
},
"setBaseForCalculations": {
"type": "boolean",
"example": false,
"description": "Grondslagen activeren. Sets baseForCalculation-related component(s) in the payroll period data based on the configuration of the employment.",
"readOnly": false
},
"setAnnualBaseForCalculationsBasedOnFunds": {
"type": "boolean",
"example": false,
"description": "Jaargrondslag fondsen bepalen. Sets baseForCalculationsBasedOnFunds-related component(s) in the payroll period data based on the configuration of the employment.",
"readOnly": false
},
"setLeaveHours": {
"type": "boolean",
"example": false,
"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.",
"readOnly": false
}
}
},
"postPayrollRun": {
"allOf": [
{
"$ref": "#/components/schemas/payrollRun"
},
{
"properties": {
"initiationParameters": {
"type": "object",
"properties": {
"typeOfInitiation": {
"type": "string",
"readOnly": false,
"enum": [
"regular",
"withoutEmploymentData",
"previousYear"
]
},
"emailAddressPayrollRunStarted": {
"type": [
"string",
"null"
],
"example": "info@loket.nl",
"description": "The e-mail address to which an email will be sent when the payroll run is started. (Email starten)",
"maxLength": 255,
"readOnly": false
},
"emailAddressPayrollRunFinished": {
"type": [
"string",
"null"
],
"example": "info@loket.nl",
"description": "The e-mail address to which an email will be sent when the payroll run is finished. (Email gereed)",
"maxLength": 255,
"readOnly": false
}
}
}
}
}
]
},
"initiatedPayrollRun": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (GUID/UUID) of the payroll run.",
"readOnly": false
}
}
},
"payrollRunInitiationvalues": {
"type": "object",
"properties": {
"payrollPeriod": {
"$ref": "#/components/schemas/payrollPeriod-2"
},
"availableForEmployeeDate": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The date on which the pay slips will be available to employees.",
"example": "2021-05-08",
"readOnly": true,
"x-loket-db-field": "Ulsa.VerloningsRun.DatumBeschikbaarEss"
},
"sendEmailToEmployee": {
"type": "boolean",
"description": "Indicates whether an email should be sent to the employees when the pay slip is available to them.",
"readOnly": true
},
"emailAddressPayrollRunStarted": {
"type": [
"string",
"null"
],
"description": "The email address to send an email to, after starting the payroll run proces.",
"readOnly": true
},
"emailAddressPayrollRunFinished": {
"type": [
"string",
"null"
],
"description": "The email address to send an email to, after the payroll run has been calculated.",
"readOnly": true
},
"emailAddressPayrollRunApproved": {
"type": [
"string",
"null"
],
"description": "The email address to send an email to, after starting the payroll run has been approved.\"",
"readOnly": true
}
}
},
"postPayrollRunCollective": {
"properties": {
"payrollAdministrationId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"availableForEmployeeDate": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The date on which the pay slips will be available to employees.",
"example": "2018-05-08",
"readOnly": false,
"x-loket-db-field": "Ulsa.VerloningsRun.DatumBeschikbaarEss"
},
"initialisePayrollPeriod": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether the initiase (berekenen uren) proces should be started. When set to true or not set, the initialising proces will be started with the default settings.",
"readOnly": false,
"default": true
}
}
},
"patchPayrollRunCollective": {
"properties": {
"payrollAdministrationId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
}
}
},
"inputParameters": {
"type": "object",
"readOnly": false,
"properties": {
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this employment starts.",
"readOnly": false
},
"endDate": {
"type": "string",
"format": "date",
"example": "2018-10-23",
"description": "The date on which the employment ends.",
"readOnly": false
},
"grossMonthlyWage": {
"type": "number",
"format": "double",
"example": 2300,
"description": "Gross wage/ basic wage for the employment per month.\n",
"minimum": 0,
"maximum": 999999.99,
"readOnly": false
},
"grossMonthlySupplement": {
"type": "number",
"format": "double",
"example": 212,
"description": "An additional monthly amount, if applicable.\n",
"minimum": 0,
"maximum": 999999.99,
"readOnly": false
},
"shiftBonusPercentage": {
"type": "number",
"format": "double",
"example": 12,
"description": "The bonus percentage used in wage calculations based on given shift.\n",
"minimum": 0,
"maximum": 99.99,
"readOnly": false
},
"baseCalculationsBonusPercentage": {
"type": "number",
"format": "double",
"example": 12,
"description": "The bonus percentage used in wage calculations based on an accumulation of given base calculations (grondslagen)\n",
"minimum": 0,
"maximum": 99.99,
"readOnly": false
}
}
},
"outputParameters": {
"type": "object",
"readOnly": true,
"properties": {
"monthlyWage": {
"type": "number",
"format": "double",
"example": 2300,
"description": "Calculated wage for the employment per month.\n",
"minimum": 0,
"maximum": 999999.99,
"readOnly": true
},
"employmentDurationInDecimalYears": {
"type": "number",
"format": "double",
"example": 3.5,
"description": "Calculated employment duration in years, as a decimal number.\n",
"minimum": 0,
"maximum": 999999.99,
"readOnly": true
},
"transitionCompensationAmount": {
"type": "number",
"format": "double",
"example": 8050,
"description": "Calculated total amount for the transition compensation.\n",
"minimum": 0,
"maximum": 999999.99,
"readOnly": true
}
}
},
"documentPutObject": {
"properties": {
"qwoaterDocumentId": {
"type": "string",
"format": "uuid",
"description": "Qwoater documentId",
"example": "",
"readOnly": true
},
"description": {
"type": "string",
"description": "The description defined by the submitter. Qwoater: Docfield 33 Omschrijving\n",
"example": "Copy of id card",
"minLength": 1,
"maxLength": 250,
"readOnly": false
},
"category": {
"format": "metadata",
"type": "string",
"description": "The category of the document. Provided value must be a valid metadata option. Qwoater: DocumentType\n",
"example": "Arbeidsovereenkomst",
"maxLength": 4000,
"readOnly": false
},
"year": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "The year the document relates to. Qwoater: Docfield 86 Jaar\n",
"example": 2017,
"minimum": 1000,
"maximum": 9999,
"readOnly": false
},
"attribute": {
"type": [
"string",
"null"
],
"description": "The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk\n",
"example": "VSP004",
"maxLength": 250,
"readOnly": false
},
"dateOfSubmission": {
"type": "string",
"format": "date",
"description": "The time at which document was submitted. Qwoater: CreationDate\n",
"example": "2018-05-08",
"readOnly": true
},
"dateOfAlert": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The time at which document will alerted for cancellation. Qwoater: AlertDate\n",
"example": "2018-05-08",
"readOnly": false
},
"submittedBy": {
"type": [
"string",
"null"
],
"description": "The name of the user that has submitted the document. Qwoater: Docfield 34 Gebruiker\n",
"example": "Bowls, John",
"maxLength": 4000,
"readOnly": true
},
"isReadBy": {
"type": "object",
"readOnly": true,
"properties": {
"provider": {
"type": "boolean",
"example": false,
"description": "Qwoater: IsReadProvider",
"readOnly": true
},
"employer": {
"type": "boolean",
"example": false,
"description": "Qwoater: IsReadEmployer",
"readOnly": true
},
"departmentManager": {
"type": "boolean",
"example": false,
"description": "Qwoater: IsReadDepartmentManager",
"readOnly": true
},
"employee": {
"type": "boolean",
"example": false,
"description": "Qwoater: IsReadEmployee",
"readOnly": true
}
}
}
}
},
"documentGetObject": {
"allOf": [
{
"$ref": "#/components/schemas/documentPutObject"
},
{
"properties": {
"filename": {
"type": "string",
"description": "The name of the file. Qwoater: Filename\n",
"example": "BowlsJohn.pdf",
"minLength": 1,
"maxLength": 255,
"readOnly": false
},
"qwoaterDirectUrl": {
"type": "string",
"description": "The URL to this document in de Qwoater direct environment (different website/application)\n",
"example": "https://direct.qwoater.nl/document/searchdocument/00000000-f100-4100-00fe-cd00e38223a3",
"maxLength": 1000,
"readOnly": false
}
}
}
]
},
"signDocumentObject": {
"allOf": [
{
"$ref": "#/components/schemas/documentGetObject"
},
{
"properties": {
"signDocumentStatus": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Status of the signature.\n",
"properties": {
"key": {
"type": "string",
"example": "Se",
"readOnly": true
},
"value": {
"type": "string",
"example": "Onderteken-verzoek verzonden",
"readOnly": true
}
}
},
"isInitiateSignDocumentRequestPossible": {
"type": [
"boolean",
"null"
],
"example": true,
"description": "Indicates whether initiate sign document request is possible.\n",
"readOnly": true
}
}
}
]
},
"documentPostObject": {
"allOf": [
{
"$ref": "#/components/schemas/documentGetObject"
},
{
"properties": {
"file": {
"type": "string",
"example": "YQ==",
"description": "base64 encoded document file.",
"readOnly": false
},
"sendEmailNotification": {
"type": [
"boolean",
"null"
],
"example": true,
"default": false,
"description": "Indicate whether to send an email to the employee.",
"readOnly": false
}
}
}
]
},
"auditTrailObject": {
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time the declaration was submitted. Qwoater: AuditEventDate\n",
"readOnly": true
},
"event": {
"type": "string",
"description": "Qwoater: Event\n",
"example": "Audittrail opgevraagd",
"readOnly": true
},
"endUser": {
"type": [
"string",
"null"
],
"description": "Qwoater: EndUser\n",
"example": "Hur, Ben",
"readOnly": true
},
"role": {
"type": "string",
"description": "Qwoater: Role\n",
"example": "Provider",
"readOnly": true
},
"category": {
"type": [
"string",
"null"
],
"description": "Qwoater: DocumentType\n",
"example": "",
"readOnly": true
},
"year": {
"type": [
"string",
"null"
],
"description": "Qwoater: Jaar\n",
"example": "2020",
"readOnly": true
},
"attribute": {
"type": [
"string",
"null"
],
"description": "Qwoater: Kenmerk\n",
"example": "",
"readOnly": true
},
"description": {
"type": [
"string",
"null"
],
"description": "Qwoater: Omschrijving\n",
"example": "VSP004",
"readOnly": true
},
"dateOfAlert": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-05-08",
"description": "The time the declaration was submitted. Qwoater: Signaleringsdatum\n",
"readOnly": true
}
}
},
"qwoaterDocumentId": {
"type": "string",
"format": "uuid",
"description": "Qwoater documentId",
"example": "",
"readOnly": true
},
"description-7": {
"type": "string",
"description": "The description defined by the submitter. Qwoater: Docfield 33 Omschrijving\n",
"example": "Copy of id card",
"minLength": 1,
"maxLength": 250,
"readOnly": false
},
"category": {
"format": "metadata",
"type": "string",
"description": "The category of the document. Provided value must be a valid metadata option. Qwoater: DocumentType\n",
"example": "Arbeidsovereenkomst",
"maxLength": 4000,
"readOnly": false
},
"year-3": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "The year the document relates to. Qwoater: Docfield 86 Jaar\n",
"example": 2017,
"minimum": 1000,
"maximum": 9999,
"readOnly": false
},
"attribute": {
"type": [
"string",
"null"
],
"description": "The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk\n",
"example": "VSP004",
"maxLength": 250,
"readOnly": false
},
"dateOfSubmission": {
"type": "string",
"format": "date",
"description": "The time at which document was submitted. Qwoater: CreationDate\n",
"example": "2018-05-08",
"readOnly": true
},
"dateOfAlert": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The time at which document will alerted for cancellation. Qwoater: AlertDate\n",
"example": "2018-05-08",
"readOnly": false
},
"submittedBy": {
"type": [
"string",
"null"
],
"description": "The name of the user that has submitted the document. Qwoater: Docfield 34 Gebruiker\n",
"example": "Bowls, John",
"maxLength": 4000,
"readOnly": true
},
"isReadBy": {
"type": "object",
"readOnly": true,
"properties": {
"provider": {
"type": "boolean",
"example": false,
"description": "Qwoater: IsReadProvider",
"readOnly": true
},
"employer": {
"type": "boolean",
"example": false,
"description": "Qwoater: IsReadEmployer",
"readOnly": true
},
"departmentManager": {
"type": "boolean",
"example": false,
"description": "Qwoater: IsReadDepartmentManager",
"readOnly": true
},
"employee": {
"type": "boolean",
"example": false,
"description": "Qwoater: IsReadEmployee",
"readOnly": true
}
}
},
"documentPutObject-2": {
"properties": {
"qwoaterDocumentId": {
"$ref": "#/components/schemas/qwoaterDocumentId"
},
"description": {
"$ref": "#/components/schemas/description-7"
},
"category": {
"$ref": "#/components/schemas/category"
},
"year": {
"$ref": "#/components/schemas/year-3"
},
"attribute": {
"$ref": "#/components/schemas/attribute"
},
"dateOfSubmission": {
"$ref": "#/components/schemas/dateOfSubmission"
},
"dateOfAlert": {
"$ref": "#/components/schemas/dateOfAlert"
},
"submittedBy": {
"$ref": "#/components/schemas/submittedBy"
},
"isReadBy": {
"$ref": "#/components/schemas/isReadBy"
}
}
},
"filename": {
"type": "string",
"description": "The name of the file. Qwoater: Filename\n",
"example": "BowlsJohn.pdf",
"minLength": 1,
"maxLength": 255,
"readOnly": false
},
"qwoaterDirectUrl": {
"type": "string",
"description": "The URL to this document in de Qwoater direct environment (different website/application)",
"example": "https://direct.qwoater.nl/document/searchdocument/00000000-f100-4100-00fe-cd00e38223a3",
"maxLength": 1024,
"readOnly": true
},
"documentGetObject-2": {
"type": "object",
"properties": {
"qwoaterDocumentId": {
"$ref": "#/components/schemas/qwoaterDocumentId"
},
"description": {
"$ref": "#/components/schemas/description-7"
},
"category": {
"$ref": "#/components/schemas/category"
},
"year": {
"$ref": "#/components/schemas/year-3"
},
"attribute": {
"$ref": "#/components/schemas/attribute"
},
"dateOfSubmission": {
"$ref": "#/components/schemas/dateOfSubmission"
},
"dateOfAlert": {
"$ref": "#/components/schemas/dateOfAlert"
},
"submittedBy": {
"$ref": "#/components/schemas/submittedBy"
},
"isReadBy": {
"$ref": "#/components/schemas/isReadBy"
},
"filename": {
"$ref": "#/components/schemas/filename"
},
"qwoaterDirectUrl": {
"$ref": "#/components/schemas/qwoaterDirectUrl"
}
}
},
"file": {
"type": "string",
"example": "YQ==",
"description": "base64 encoded document file.",
"readOnly": false
},
"sendEmailNotification": {
"type": [
"boolean",
"null"
],
"example": true,
"default": false,
"description": "Indicate whether to send an email to the employees.",
"readOnly": false
},
"documentPostObject-2": {
"type": "object",
"properties": {
"qwoaterDocumentId": {
"$ref": "#/components/schemas/qwoaterDocumentId"
},
"description": {
"$ref": "#/components/schemas/description-7"
},
"category": {
"$ref": "#/components/schemas/category"
},
"year": {
"$ref": "#/components/schemas/year-3"
},
"attribute": {
"$ref": "#/components/schemas/attribute"
},
"dateOfSubmission": {
"$ref": "#/components/schemas/dateOfSubmission"
},
"dateOfAlert": {
"$ref": "#/components/schemas/dateOfAlert"
},
"submittedBy": {
"$ref": "#/components/schemas/submittedBy"
},
"isReadBy": {
"$ref": "#/components/schemas/isReadBy"
},
"file": {
"$ref": "#/components/schemas/file"
},
"sendEmailNotification": {
"$ref": "#/components/schemas/sendEmailNotification"
}
}
},
"auditTrailObject-2": {
"properties": {
"eventDate": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time the declaration was submitted. Qwoater: AuditEventDate\n",
"readOnly": true
},
"event": {
"type": "string",
"description": "Qwoater: Event\n",
"example": "Audittrail opgevraagd",
"readOnly": true
},
"endUser": {
"type": "string",
"description": "Qwoater: EndUser\n",
"example": "Hur, Ben",
"readOnly": true
},
"role": {
"type": "string",
"description": "Qwoater: Role\n",
"example": "Provider",
"readOnly": true
},
"category": {
"type": "string",
"description": "Qwoater: DocumentType\n",
"example": "",
"readOnly": true
},
"year": {
"type": [
"string",
"null"
],
"description": "Qwoater: Jaar\n",
"example": "2020",
"readOnly": true
},
"attribute": {
"type": [
"string",
"null"
],
"description": "Qwoater: Kenmerk\n",
"example": "",
"readOnly": true
},
"description": {
"type": "string",
"description": "Qwoater: Omschrijving\n",
"example": "VSP004",
"readOnly": true
},
"dateOfAlert": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-05-08",
"description": "The time the declaration was submitted. Qwoater: Signaleringsdatum\n",
"readOnly": true
}
}
},
"signDocumentObject-2": {
"allOf": [
{
"$ref": "#/components/schemas/documentGetObject"
},
{
"properties": {
"signDocumentStatus": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Status of the signature.\n",
"properties": {
"key": {
"type": [
"string",
"null"
],
"example": "Se",
"readOnly": true
},
"value": {
"type": [
"string",
"null"
],
"example": "Onderteken-verzoek verzonden",
"readOnly": true
}
}
},
"isInitiateSignDocumentRequestPossible": {
"type": [
"boolean",
"null"
],
"example": true,
"description": "Indicates whether initiate sign document request is possible.\n",
"readOnly": true
}
}
}
]
},
"documentPostObject-3": {
"allOf": [
{
"$ref": "#/components/schemas/documentGetObject"
},
{
"properties": {
"file": {
"type": "string",
"example": "YQ==",
"description": "base64 encoded document file.",
"readOnly": false
}
}
}
]
},
"documentCountObject": {
"properties": {
"numberOfDocuments": {
"type": "integer",
"format": "int32",
"description": "The number of documents in the dossier, regarthless of who has access to them.",
"example": 7,
"readOnly": true
}
}
},
"documentPutObject-3": {
"properties": {
"qwoaterDocumentId": {
"type": "string",
"format": "uuid",
"description": "Qwoater documentId",
"example": "",
"readOnly": true
},
"description": {
"type": "string",
"description": "The description defined by the submitter. Qwoater: Docfield 33 Omschrijving\n",
"example": "Copy of id card",
"minLength": 1,
"maxLength": 250,
"readOnly": false
},
"year": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "The year the document relates to. Qwoater: Docfield 86 Jaar\n",
"example": 2017,
"minimum": 1000,
"maximum": 9999,
"readOnly": false
},
"attribute": {
"type": [
"string",
"null"
],
"description": "The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk\n",
"example": "VSP004",
"maxLength": 250,
"readOnly": false
},
"dateOfAlert": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The time at which document will alerted for cancellation. Qwoater: AlertDate\n",
"example": "2018-05-08",
"readOnly": false
}
}
},
"documentGetObject-3": {
"allOf": [
{
"$ref": "#/components/schemas/documentPutObject-3"
},
{
"properties": {
"targetCategory": {
"format": "metadata",
"type": "string",
"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\n",
"example": "Arbeidsovereenkomst",
"maxLength": 4000,
"readOnly": false
},
"dateOfSubmission": {
"type": "string",
"format": "date",
"description": "The time at which document was submitted. Qwoater: CreationDate\n",
"example": "2018-05-08",
"readOnly": true
},
"filename": {
"type": "string",
"description": "The name of the file. Qwoater: Filename\n",
"example": "BowlsJohn.pdf",
"minLength": 1,
"maxLength": 255,
"readOnly": false
}
}
}
]
},
"documentPostObject-4": {
"allOf": [
{
"$ref": "#/components/schemas/documentGetObject-3"
},
{
"properties": {
"file": {
"type": "string",
"example": "YQ==",
"description": "base64 encoded document file.",
"readOnly": false
}
}
}
]
},
"documentPostObject-5": {
"properties": {
"description": {
"type": "string",
"description": "The description defined by the submitter. Qwoater: Docfield 33 Omschrijving\n",
"example": "Copy of id card",
"minLength": 1,
"maxLength": 250,
"readOnly": false
},
"year": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "The year the document relates to. Qwoater: Docfield 86 Jaar\n",
"example": 2017,
"minimum": 1000,
"maximum": 9999,
"readOnly": false
},
"attribute": {
"type": [
"string",
"null"
],
"description": "The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk\n",
"example": "VSP004",
"maxLength": 250,
"readOnly": false
},
"dateOfAlert": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The date at which document will alerted for cancellation. Qwoater: AlertDate\n",
"example": "2018-05-08",
"readOnly": false
},
"filename": {
"type": "string",
"description": "The name of the file. Qwoater: Filename\n",
"example": "BowlsJohn.pdf",
"minLength": 1,
"maxLength": 250,
"readOnly": false
},
"templateEmployerId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of the employer to which the template belongs (GUID/UUID).",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"referenceDate": {
"type": "string",
"format": "date",
"description": "This date will be used to select date depending data such as department and function.\n",
"example": "2020-05-08",
"readOnly": false
}
}
},
"documentPostWithEmailObject": {
"allOf": [
{
"$ref": "#/components/schemas/documentPostObject-5"
},
{
"properties": {
"sendEmailNotification": {
"type": [
"boolean",
"null"
],
"example": true,
"default": false,
"description": "Indicate whether to send an email to the employee.",
"readOnly": false
}
}
}
]
},
"documentPostWithEmployments": {
"allOf": [
{
"$ref": "#/components/schemas/documentPostObject-5"
},
{
"properties": {
"sendEmailNotification": {
"type": [
"boolean",
"null"
],
"example": true,
"default": false,
"description": "Indicate whether to send an email to the employees.",
"readOnly": false
},
"employmentIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
}
}
}
}
]
},
"documentSignObject": {
"properties": {
"emailAddress": {
"type": "string",
"example": "test@test.com",
"description": "The email address of the signer.",
"minimum": 1,
"maximum": 255,
"readOnly": false
},
"name": {
"type": "string",
"example": "Ben Hur",
"description": "The name of the signer",
"minimum": 1,
"maximum": 255,
"readOnly": false
},
"mobilePhoneNumber": {
"type": "string",
"example": "+31612345678",
"description": "The mobile phone number of the signer. In E.164 format",
"readOnly": false
},
"signingOrder": {
"type": [
"integer",
"null"
],
"example": "2",
"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.",
"readOnly": false
}
}
},
"signatureDocumentStatusObject": {
"properties": {
"signDocumentStatus": {
"type": "object",
"description": "Status of the signature at document level",
"properties": {
"Key": {
"type": "string",
"example": "Ne",
"description": "The key of the status"
},
"Value": {
"type": "string",
"example": "Nieuw onderteken-verzoek",
"description": "The description of the status."
}
}
}
}
},
"signatureStatusObject": {
"properties": {
"signDocumentStatus": {
"type": "object",
"description": "Status of the signature at document level",
"properties": {
"Key": {
"type": "string",
"example": "Ne",
"description": "The key of the status"
},
"Value": {
"type": "string",
"example": "Nieuw onderteken-verzoek",
"description": "The description of the status."
}
}
},
"signerStatus": {
"type": "array",
"items": {
"type": [
"object",
"null"
],
"description": "Status of the signature per signer",
"properties": {
"declined": {
"type": "boolean",
"example": true,
"description": "Has the signer declined to sign the document?"
},
"emailed": {
"type": "boolean",
"example": true,
"description": "Has the signer received an email to sign the document?"
},
"signed": {
"type": "boolean",
"example": true,
"description": "Has the signer received an email to sign the document?"
},
"viewed": {
"type": "boolean",
"example": true,
"description": "Has the signer viewed the document?"
},
"signedOnDate": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2021-02-24T08:20:33.105668Z",
"description": "The date/time at which the signer has signed the document"
},
"emailAddress": {
"type": "string",
"example": "test@test.com",
"description": "The email address of the signer."
},
"name": {
"type": "string",
"example": "Ben Hur",
"description": "The name of the signer"
}
}
}
}
}
},
"authorizationsObject": {
"properties": {
"category": {
"type": "string",
"description": "The category\n",
"example": "Arbeidsovereenkomst",
"readOnly": false
},
"isAuthorizaionEditRestricted": {
"type": "boolean",
"description": "Indicates whether the authorizations of the category can be edited or not.\n",
"readOnly": true
},
"isTemplate": {
"type": "boolean",
"description": "Indicates whether the category is a template.\n",
"readOnly": true
},
"canWrite": {
"type": "object",
"description": "This object describes the authorization per category for each role.\n",
"properties": {
"provider": {
"type": "boolean",
"example": true,
"readOnly": false
},
"employer": {
"type": "boolean",
"example": false,
"readOnly": false
},
"departmentManager": {
"type": "boolean",
"example": false,
"readOnly": false
},
"employee": {
"type": "boolean",
"example": false,
"readOnly": false
}
}
}
}
},
"apgPensionDeclaration": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"messageReference": {
"type": [
"string",
"null"
],
"description": "The message reference (berichtkenmerk) to recognize the given declaration.\n",
"example": "190",
"readOnly": true
},
"methodOfCreation": {
"type": "object",
"format": "metadata",
"description": "Method by which the creation of the run was triggered.",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false
},
"value": {
"type": "string",
"example": "Individueel",
"readOnly": true
}
}
},
"customerGroupNumber": {
"type": "integer",
"format": "int32",
"description": "Pension declarations will alway be grouped by its customerGroupNumber (klantgroepnummer).",
"readOnly": true
},
"apgPensionDeclarationStatus": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "The current status of the tax return\nPossible values:\n* Verzoek tot aanmaak pensioenaangifte (key = 1)\n* Fout bij aanmaken pensioenaangifte (key = 2)\n* Pensioenaangifte aangemaakt (key = 3)\n* Pensioenaangifte geannuleerd (key = 4)\n* Pensioenaangifte bevestigd (key = 5)\n* Pensioenaangifte verzonden (key = 6)\n* Pensioenaangifte verwijderd (key = 7)\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3
},
"value": {
"type": "string",
"example": "Pensioenaangifte aangemaakt"
}
}
},
"period": {
"type": "object",
"format": "metadata",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the period for which the pension declaration was created.",
"example": 2017,
"readOnly": true
},
"periodNumber": {
"type": "integer",
"format": "int32",
"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,
"readOnly": true
},
"periodId": {
"type": "integer",
"format": "int32",
"description": "The periodId of the payroll period.",
"example": 202101,
"readOnly": true
},
"periodType": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"description": "Indicates the frequence of the process. Payrolling can be done on a montly, 4-weekly or weekly basis.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true
},
"value": {
"type": "string",
"example": "month",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.omschrijving"
}
}
},
"periodStartDate": {
"type": "string",
"format": "date",
"example": "2021-11-01",
"description": "The start date of the period",
"readOnly": false
},
"periodEndDate": {
"type": "string",
"format": "date",
"example": "2021-11-30",
"description": "The end date of the period",
"readOnly": false
}
}
},
"withholdingAgentName": {
"type": "string",
"description": "The withholding agent name (naam inhoudingsplichtige) for this return.\n",
"example": "Ben-Hur BV Via Roma",
"readOnly": true
},
"externalParty": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "External party (externe partij)",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 13,
"readOnly": true
},
"value": {
"type": "string",
"example": "PFZW (APG)",
"readOnly": true
}
}
},
"requestTime": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the run was requested by the user",
"readOnly": true
},
"creationTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the pension message was requested by the user",
"readOnly": true
},
"approvalTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the payroll run was approved by the user",
"readOnly": true
},
"sentTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The time at which the pay roll run was sent.",
"example": "2018-05-08T15:16:49+02:00",
"readOnly": true
},
"removeTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The time at which the pay roll run was removed.",
"example": "2018-05-08T15:16:49+02:00",
"readOnly": true
},
"requestedBy": {
"$ref": "#/components/schemas/userBasicNotNullable"
},
"approvedBy": {
"$ref": "#/components/schemas/userBasic"
},
"removedBy": {
"$ref": "#/components/schemas/userBasic"
},
"cancelledTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the payroll run was Cancelled by the user",
"readOnly": true
},
"cancelledBy": {
"$ref": "#/components/schemas/userBasic"
},
"responseMessages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datetimeOfRegistration": {
"type": "string",
"format": "date-time",
"example": "2016-01-19",
"description": "The date on which the response message was registered in Loket",
"readOnly": true
},
"datetimeOfMessageReceipt": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2016-01-19",
"description": "The date on which the original message was received by the external entity",
"readOnly": true
},
"description": {
"type": [
"string",
"null"
],
"example": "Bestand ontvangen",
"description": "The description of the response message",
"readOnly": true
}
}
}
}
}
},
"apgPensionDeclarationPatch": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"confirm",
"cancel"
],
"description": "The action to perform on the apg pensiondeclaration",
"readOnly": false
}
},
"required": [
"action"
]
},
"initiationParametersPensionDeclaration": {
"type": "object",
"properties": {
"payrollPeriod": {
"type": "object",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period the request relates to",
"example": 2024,
"readOnly": false
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period number of the payroll period the request relates to",
"example": 1,
"readOnly": false
}
}
}
}
},
"initiatedApgPensionDeclaration": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
},
"initiationParametersForPreviousPayrollYear-2": {
"type": "object",
"properties": {
"payrollYear": {
"type": "string",
"example": 2022,
"readOnly": false
}
}
},
"upaPensionDeclaration": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"messageReference": {
"type": [
"string",
"null"
],
"description": "The message reference (berichtkenmerk) to recognize the given declaration.\n",
"example": "190",
"readOnly": true
},
"methodOfCreation": {
"type": "object",
"format": "metadata",
"description": "Method by which the creation of the run was triggered.",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false
},
"value": {
"type": "string",
"example": "Individueel",
"readOnly": true
}
}
},
"payrollTaxesNumber": {
"type": [
"string",
"null"
],
"example": "111111110L46",
"minLength": 12,
"maxLength": 12,
"description": "The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst.",
"readOnly": false
},
"upaPensionDeclarationStatus": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "The current status of the pension declaration\n\nPossible values:\n* Verzoek tot aanmaak pensioenaangifte (key = 1)\n* Fout bij aanmaken pensioenaangifte (key = 2)\n* Pensioenaangifte aangemaakt (key = 3)\n* Pensioenaangifte geannuleerd (key = 4)\n* Pensioenaangifte bevestigd (key = 5)\n* Pensioenaangifte verzonden (key = 6)\n* Pensioenaangifte verwijderd (key = 7)\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 3
},
"value": {
"type": "string",
"example": "Pensioenaangifte aangemaakt"
}
}
},
"period": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the period for which the pension declaration was created.",
"example": 2017,
"readOnly": true
},
"periodNumber": {
"type": "integer",
"format": "int32",
"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,
"readOnly": true
},
"periodId": {
"type": "integer",
"format": "int32",
"description": "The periodId of the payroll period.",
"example": 202101,
"readOnly": true
},
"periodType": {
"type": [
"object",
"null"
],
"readOnly": true,
"description": "Indicates the frequence of the process. Payrolling can be done on a montly, 4-weekly or weekly basis.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true
},
"value": {
"type": "string",
"example": "month",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.omschrijving"
}
}
},
"periodStartDate": {
"type": "string",
"format": "date",
"example": "2021-11-01",
"description": "The start date of the period",
"readOnly": false
},
"periodEndDate": {
"type": "string",
"format": "date",
"example": "2021-11-30",
"description": "The end date of the period",
"readOnly": false
}
}
},
"withholdingAgentName": {
"type": "string",
"description": "The withholding agent name (naam inhoudingsplichtige) for this return.\n",
"example": "Ben-Hur BV Via Roma",
"readOnly": true
},
"externalParty": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "External party (externe partij)",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 13,
"readOnly": true
},
"value": {
"type": "string",
"example": "PFZW (UPA)",
"readOnly": true
}
}
},
"sendingPartyNumber": {
"type": "string",
"description": "The number of the sending party (i.e. nummer leverancier).\n",
"example": "SWO00077",
"readOnly": true
},
"requestTime": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the payroll run was requested by the user",
"readOnly": true
},
"creationTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the pension message was requested by the user",
"readOnly": true
},
"approvalTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the payroll run was approved by the user",
"readOnly": true
},
"cancelledTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the payroll run was Cancelled by the user",
"readOnly": true
},
"sentTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The time at which the pay roll run was sent.",
"example": "2018-05-08T15:16:49+02:00",
"readOnly": true
},
"removeTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The time at which the pay roll run was removed.",
"example": "2018-05-08T15:16:49+02:00",
"readOnly": true
},
"requestedBy": {
"$ref": "#/components/schemas/userBasicNotNullable"
},
"approvedBy": {
"$ref": "#/components/schemas/userBasic"
},
"cancelledBy": {
"$ref": "#/components/schemas/userBasic"
},
"removedBy": {
"$ref": "#/components/schemas/userBasic"
},
"responseMessages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"datetimeOfRegistration": {
"type": "string",
"format": "date-time",
"example": "2016-01-19",
"description": "The date on which the response message was registered in Loket",
"readOnly": true
},
"datetimeOfMessageReceipt": {
"type": "string",
"format": "date-time",
"example": "2016-01-19",
"description": "The date on which the original message was received by the external entity",
"readOnly": true
},
"responseType": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false
},
"value": {
"type": "string",
"example": "Ontvangstbevestiging (ACK)",
"readOnly": true
}
}
},
"responseStatus": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false
},
"value": {
"type": "string",
"example": "Bericht niet OK (NOK)",
"readOnly": true
}
}
},
"citizenServiceNumber": {
"type": [
"string",
"null"
],
"example": "042168588",
"minLength": 9,
"maxLength": 9,
"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).",
"readOnly": true
},
"incomeRelationshipNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"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.",
"minimum": 0,
"maximum": 9999,
"readOnly": true,
"x-loket-db-field": "Loket.Dienstverband.NummerInkomstenVerhouding"
},
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 156,
"minimum": 1,
"description": "The employee number to uniquely identify an employee within an employer\n",
"readOnly": true
},
"code": {
"type": "string",
"example": "NOK",
"description": "The description of the response message",
"readOnly": true
},
"description": {
"type": "string",
"example": "De werkgever heeft geen contract voor de opgegeven regeling. Doe opnieuw aangifte zonder deze regeling.",
"description": "The description of the response message",
"readOnly": true
},
"descriptionFragment": {
"type": "string",
"example": "Het Loonheffingennummer moet bestaan, bekend en in gebruik zijn bij de PUO.",
"description": "The description of the response message",
"readOnly": true
},
"errorType": {
"type": [
"string",
"null"
],
"example": "F",
"description": "If there is an error type then this field contain its value.",
"readOnly": true
},
"lineNumber": {
"type": [
"integer",
"null"
],
"example": 14,
"description": "If there is an error type then this field contain a value.",
"readOnly": true
},
"linePosition": {
"type": [
"integer",
"null"
],
"example": 11,
"description": "If there is an error type then this field contain a value.",
"readOnly": true
}
}
}
}
}
},
"initiatedUpaPensionDeclaration": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
},
"upaPensionDeclarationPatch": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"confirm",
"cancel"
],
"description": "The action to perform on the upa pensiondeclaration",
"readOnly": false
}
},
"required": [
"action"
]
},
"pensionDeclarationCollective": {
"properties": {
"payrollAdministrationId": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false
},
"externalPartyKey": {
"type": "integer",
"description": "The key of the external party.\n",
"example": 14,
"readOnly": false
}
}
},
"externalPartyReadOnlyTrue": {
"type": "object",
"format": "metadata",
"readOnly": true,
"description": "External party (externe partij)",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 13,
"readOnly": true
},
"value": {
"type": "string",
"example": "AZL (UPA)",
"readOnly": true
}
}
},
"externalIdentification": {
"type": "string",
"example": "123456789",
"description": "External identification (externe identificatie)\nFor a UPA pension provider use the idLCr",
"maxLength": 9,
"readOnly": false
},
"externalPartyIdentificationPut": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"externalParty": {
"$ref": "#/components/schemas/externalPartyReadOnlyTrue"
},
"externalIdentification": {
"$ref": "#/components/schemas/externalIdentification"
}
}
},
"externalPartyReadOnlyFalse": {
"type": "object",
"format": "metadata",
"readOnly": false,
"description": "External party (externe partij)",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 13,
"readOnly": false
},
"value": {
"type": "string",
"example": "AZL (UPA)",
"readOnly": true
}
}
},
"externalPartyIdentificationPost": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"externalParty": {
"$ref": "#/components/schemas/externalPartyReadOnlyFalse"
},
"externalIdentification": {
"$ref": "#/components/schemas/externalIdentification"
}
}
},
"stippInitiationInformation": {
"type": "object",
"properties": {
"emailAddress": {
"type": [
"string",
"null"
],
"example": "test@test.com",
"description": "The email address",
"minimum": 1,
"maximum": 40,
"readOnly": true
},
"payrollPeriod": {
"$ref": "#/components/schemas/payrollPeriod-2"
},
"referenceDate": {
"type": "string",
"format": "date",
"example": "2018-10-23",
"description": "The date that functions as a cutoff moment to determine if a payroll run is to be included in the pension wage statement (PLO) or not",
"readOnly": true
}
}
},
"stippDownloadInformation": {
"type": "object",
"properties": {
"payrollRun": {
"type": "object",
"properties": {
"payrollRunId": {
"$ref": "#/components/schemas/id"
},
"payrollPeriod": {
"$ref": "#/components/schemas/payrollPeriod-2"
},
"sequenceNumberApproved": {
"type": "integer",
"format": "int32",
"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. ",
"readOnly": true,
"example": 6
},
"textPaySlip": {
"type": [
"string",
"null"
],
"description": "An optional text provided by an authorized user that will be displayed on the pay slip.",
"maxLength": 25,
"readOnly": false
},
"textPayment": {
"type": [
"string",
"null"
],
"description": "An optional text provided by an authorized user that will be displayed as a description for the payment.",
"maxLength": 32,
"readOnly": false
},
"requestTime": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the payroll run was requested by the user",
"readOnly": true
},
"processingFinishedTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "Date-time when the calculations of the wages was finished",
"readOnly": true
},
"approvalTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the payroll run was approved by the user",
"readOnly": true
}
}
}
}
},
"stippDownloadInput": {
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"example": "test@test.com",
"description": "The email address",
"minimum": 1,
"maximum": 40,
"readOnly": false
},
"dataProvider": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Hendrix BV",
"description": "The name of the data provider",
"minimum": 1,
"maximum": 42,
"readOnly": false
},
"address": {
"type": "string",
"example": "Langeput straat 32, Tilburg",
"description": "The address of the data provider",
"minimum": 1,
"maximum": 50,
"readOnly": false
}
}
},
"contactInformation": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Piet Hendrix",
"description": "The name of the contact",
"minimum": 1,
"maximum": 40,
"readOnly": false
},
"phoneNumber": {
"type": "string",
"example": "013-1345671",
"description": "The phone number of the contact",
"minimum": 1,
"maximum": 11,
"readOnly": false
}
}
}
}
},
"pggmInitiationInformation": {
"type": "object",
"properties": {
"payrollPeriod": {
"$ref": "#/components/schemas/payrollPeriod-2"
},
"referenceDate": {
"type": "string",
"format": "date",
"example": "2018-10-23",
"description": "The date that functions as a cutoff moment to determine if a payroll run is to be included in the pension wage statement (PLO) or not",
"readOnly": true
}
}
},
"pggmDownloadInformation": {
"type": "object",
"properties": {
"payrollRun": {
"type": "object",
"properties": {
"payrollRunId": {
"$ref": "#/components/schemas/id"
},
"payrollPeriod": {
"$ref": "#/components/schemas/payrollPeriod-2"
},
"sequenceNumberApproved": {
"type": "integer",
"format": "int32",
"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. ",
"readOnly": true,
"example": 6
},
"textPaySlip": {
"type": [
"string",
"null"
],
"description": "An optional text provided by an authorized user that will be displayed on the pay slip.",
"maxLength": 25,
"readOnly": false
},
"textPayment": {
"type": [
"string",
"null"
],
"description": "An optional text provided by an authorized user that will be displayed as a description for the payment.",
"maxLength": 32,
"readOnly": false
},
"requestTime": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the payroll run was requested by the user",
"readOnly": true
},
"processingFinishedTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "Date-time when the calculations of the wages was finished",
"readOnly": true
},
"approvalTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the payroll run was approved by the user",
"readOnly": true
}
}
}
}
},
"pggmDownloadInput": {
"type": "object",
"properties": {
"referenceDate": {
"type": "string",
"format": "date",
"example": "2018-10-23",
"description": "The date that functions as a cutoff moment to determine if a payroll run is to be included in the pension wage statement (PLO) or not",
"readOnly": true
},
"dataProvider": {
"type": [
"object",
"null"
],
"properties": {
"deviatingName": {
"type": [
"string",
"null"
],
"example": "Hendrix BV",
"description": "The deviating name of the data provider. If left empty the name of the payroll administration is used",
"minimum": 1,
"maxLength": 70,
"readOnly": false
},
"deviatingConnectionNumber": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 999999999,
"example": 458741,
"description": "The deviating Connection Number (aansluitnummer) of the data provider. IF left empty the klantgroepnummer of the payroll administration is used",
"readOnly": false
}
}
},
"sectorCompanyClassification": {
"type": "object",
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "Key of the sector company classification",
"readOnly": false
},
"value": {
"type": "string",
"example": "(056007) SAG",
"description": "value of the sector company classification",
"maxLength": 50,
"readOnly": true
}
}
}
}
},
"downloadRequest": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the download request relates to",
"example": 2017,
"minimum": 2000,
"maximum": 9999,
"readOnly": false
},
"downloadRequestStatus": {
"type": "object",
"format": "metadata",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "The key indicating the current status of the download request.",
"readOnly": true
},
"value": {
"type": "string",
"example": "Bestand aangemaakt",
"readOnly": true
}
}
},
"requestTime": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the download request was created by the user",
"readOnly": true
},
"processingFinishedTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-09T15:16:49+02:00",
"description": "The time when the download become available.",
"readOnly": true
},
"expirationTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-16T15:16:49+02:00",
"description": "The time at which the download will expire.",
"readOnly": true
},
"latestDownloadTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-09T15:16:49+02:00",
"description": "The time of the most recent download.",
"readOnly": true
},
"filename": {
"type": [
"string",
"null"
],
"description": "The name of the download file.\n",
"example": "WerkgeverDownload.rar",
"maxLength": 4000,
"readOnly": true
}
}
},
"note": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "The date on which the note was created\n",
"example": "2018-01-01",
"readOnly": true
},
"createdBy": {
"$ref": "#/components/schemas/userBasic"
},
"accessibleBy": {
"type": "object",
"description": "Indicates who can view this node.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for accessible by",
"readOnly": false
},
"value": {
"type": "string",
"example": "Everyone",
"description": "Description of the accessible by",
"maxLength": 50,
"readOnly": true
}
}
},
"subject": {
"type": "string",
"example": "Remember to do xyz",
"description": "subject of the note",
"maxLength": 250,
"readOnly": false
},
"note": {
"type": [
"string",
"null"
],
"example": "Remember to do xyz",
"description": "The note it self.\n\n__Note:__ This is a free text field so users can add htlm/script etc.",
"maxLength": 4000,
"readOnly": false
},
"lastModifiedOn": {
"type": "string",
"format": "date-time",
"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",
"readOnly": true
},
"lastModifiedBy": {
"$ref": "#/components/schemas/userBasic"
}
}
},
"notesByEmployer": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "The date on which the note was created\n",
"example": "2018-01-01",
"readOnly": true
},
"createdBy": {
"$ref": "#/components/schemas/userBasic"
},
"accessibleBy": {
"type": "object",
"description": "Indicates who can view this node.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for accessible by",
"readOnly": false
},
"value": {
"type": "string",
"example": "Everyone",
"description": "Description of the accessible by",
"maxLength": 50,
"readOnly": true
}
}
},
"subject": {
"type": "string",
"example": "Remember to do xyz",
"description": "subject of the note",
"maxLength": 250,
"readOnly": false
},
"note": {
"type": [
"string",
"null"
],
"example": "Remember to do xyz",
"description": "The note it self.\n\n__Note:__ This is a free text field so users can add htlm/script etc.",
"maxLength": 4000,
"readOnly": false
},
"lastModifiedOn": {
"type": "string",
"format": "date-time",
"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",
"readOnly": true
},
"lastModifiedBy": {
"$ref": "#/components/schemas/userBasic"
},
"concerningEmployee": {
"type": "object",
"description": "Information on the concerning employee.\n",
"properties": {
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 156,
"description": "The employee number to uniquely identify a employee within an employer.",
"readOnly": true
},
"formattedName": {
"type": "string",
"example": "Wiel - van Bergen S.L. van de",
"description": "Formatted name of the employee based on the value of `howToFormatLastName`",
"maxLength": 82,
"readOnly": true
}
}
}
}
},
"notesByEmployer-2": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "The date on which the note was created\n",
"example": "2018-01-01",
"readOnly": true
},
"createdBy": {
"$ref": "#/components/schemas/userBasic"
},
"accessibleBy": {
"type": "object",
"description": "Indicates who can view this node.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for accessible by",
"readOnly": false
},
"value": {
"type": "string",
"example": "Everyone",
"description": "Description of the accessible by",
"maxLength": 50,
"readOnly": true
}
}
},
"subject": {
"type": "string",
"example": "Remember to do xyz",
"description": "subject of the note",
"maxLength": 250,
"readOnly": false
},
"note": {
"type": [
"string",
"null"
],
"example": "Remember to do xyz",
"description": "The note it self.\n\n__Note:__ This is a free text field so users can add htlm/script etc.",
"maxLength": 4000,
"readOnly": false
},
"lastModifiedOn": {
"type": "string",
"format": "date-time",
"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",
"readOnly": true
},
"lastModifiedBy": {
"$ref": "#/components/schemas/userBasic"
},
"concerningEmployee": {
"type": "object",
"description": "Information on the concerning employee.\n",
"properties": {
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 156,
"description": "The employee number to uniquely identify a employee within an employer.",
"readOnly": true
},
"formattedName": {
"type": "string",
"example": "Wiel - van Bergen S.L. van de",
"description": "Formatted name of the employee based on the value of `howToFormatLastName`",
"readOnly": true
}
}
}
}
},
"notesByPayrollAdministration": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "The date on which the note was created\n",
"example": "2018-01-01",
"readOnly": true
},
"createdBy": {
"$ref": "#/components/schemas/userBasic"
},
"accessibleBy": {
"type": "object",
"description": "Indicates who can view this node.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key for accessible by",
"readOnly": false
},
"value": {
"type": "string",
"example": "Everyone",
"description": "Description of the accessible by",
"maxLength": 50,
"readOnly": true
}
}
},
"subject": {
"type": "string",
"example": "Remember to do xyz",
"description": "subject of the note",
"maxLength": 250,
"readOnly": false
},
"note": {
"type": [
"string",
"null"
],
"example": "Remember to do xyz",
"description": "The note it self.\n\n__Note:__ This is a free text field so users can add htlm/script etc.",
"maxLength": 4000,
"readOnly": false
},
"lastModifiedOn": {
"type": "string",
"format": "date-time",
"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",
"readOnly": true
},
"lastModifiedBy": {
"$ref": "#/components/schemas/userBasic"
},
"concerningPayrollRun": {
"type": "object",
"description": "details of the PayrollRun",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"payrollPeriod": {
"type": "object",
"format": "metadata",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period the record relates to",
"example": 2023,
"readOnly": false
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period number of the payroll period the record relates to",
"example": 2,
"readOnly": false
}
}
},
"processingFinishedTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "Date-time when the calculations of the wages was finished",
"readOnly": true,
"x-loket-db-field": "Ulsa.VerloningsRun.DatumVerloning"
},
"approvalTime": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time at which the payroll run was approved by the user",
"readOnly": true,
"x-loket-db-field": "Ulsa.VerloningsRun.DatumAfgehandeld"
},
"sequenceNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"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,
"readOnly": true,
"x-loket-db-field": "Ulsa.VerloningsRun.Volgnummer",
"x-loket-implementation": "Een 0 waarde in de database wordt in de API teruggegeven als NULL. Hierdoor is dit veld in de API nullable terwijl dit in de database niet zo is."
}
}
}
}
},
"versionObject": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"lastModifiedVersionNumber": {
"type": "integer",
"format": "int64",
"example": 70429274999853,
"description": "The version number reflects the latest version of all predefined underlying tables of this employer/employment.",
"readOnly": true
}
}
},
"emailTemplate": {
"properties": {
"type": {
"type": "object",
"description": "The type of the email template",
"readOnly": true,
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Verlofaanvraag behandeld (voor de indiener)",
"description": "The description of the type of the email template."
},
"sortOrder": {
"type": "integer",
"example": 210,
"description": "A number used to sort the list."
}
}
},
"category": {
"type": "object",
"description": "The module to which the email template belongs",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"example": 3,
"description": "The id of the categorie to which the email template belongs."
},
"value": {
"type": "string",
"example": "Verlof",
"description": "The name of the categorie to which the email template belongs."
}
}
},
"email": {
"type": "object",
"description": "The configurable parts of the email template",
"readOnly": false,
"properties": {
"subject": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"example": "Verlofaanvraag behandeld",
"description": "The subjectline of the email.",
"readOnly": false
},
"body": {
"type": "string",
"minLength": 1,
"maxLength": 6000,
"example": "Je verlofaanvraag is behandeld.",
"description": "The body text of the email.",
"readOnly": false
},
"senderEmail": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"example": "noreply@loket.nl",
"description": "The email address of the sender.",
"readOnly": false
}
}
},
"dependsOnModule": {
"type": "object",
"description": "The module to which the email template belongs",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The id of the module to which the email template belongs."
},
"description": {
"type": "string",
"example": "Verlof",
"description": "The name of the module to which the email template belongs."
}
}
},
"definedAtLevel": {
"type": "string",
"enum": [
"provider",
"loket"
],
"example": "provider",
"description": "The level at which the email template is defined.",
"readOnly": true
},
"isEmailTemplateEditable": {
"type": "boolean",
"example": true,
"description": "Indicates whether the email template can be editted.",
"readOnly": true
}
}
},
"emailTemplateRequestBody": {
"properties": {
"subject": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"example": "Verlofaanvraag behandeld",
"description": "The subjectline of the email.",
"readOnly": false
},
"body": {
"type": "string",
"minLength": 1,
"maxLength": 6000,
"example": "Je verlofaanvraag is behandeld.",
"description": "The body text of the email.",
"readOnly": false
},
"senderEmail": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"example": "noreply@loket.nl",
"description": "The email address of the sender.",
"readOnly": false
}
}
},
"sendTestEmailRequestBody": {
"properties": {
"to": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"example": "info@loket.nl",
"description": "The email address to which the test email will be sent. Can be a dot-comma (;) separated list of email addresses."
}
}
},
"emailTemplate-2": {
"properties": {
"type": {
"type": "object",
"description": "The type of the email template",
"readOnly": true,
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Verlofaanvraag behandeld (voor de indiener)",
"description": "The description of the type of the email template."
},
"sortOrder": {
"type": "integer",
"example": 210,
"description": "A number used to sort the list."
}
}
},
"category": {
"type": "object",
"description": "The module to which the email template belongs",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"example": 3,
"description": "The id of the categorie to which the email template belongs."
},
"value": {
"type": "string",
"example": "Verlof",
"description": "The name of the categorie to which the email template belongs."
}
}
},
"email": {
"type": "object",
"description": "The configurable parts of the email template",
"readOnly": false,
"properties": {
"subject": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"example": "Verlofaanvraag behandeld",
"description": "The subjectline of the email.",
"readOnly": false
},
"body": {
"type": "string",
"minLength": 1,
"maxLength": 200000,
"example": "Je verlofaanvraag is behandeld.",
"description": "The body text of the email.",
"readOnly": false
},
"senderEmail": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"example": "noreply@loket.nl",
"description": "The email address of the sender.",
"readOnly": false
}
}
},
"dependsOnModule": {
"type": "object",
"description": "The module to which the email template belongs",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The id of the module to which the email template belongs."
},
"description": {
"type": "string",
"example": "Verlof",
"description": "The name of the module to which the email template belongs."
}
}
},
"definedAtLevel": {
"type": "string",
"enum": [
"employer",
"provider",
"loket"
],
"example": "employer",
"description": "The level at which the email template is defined.",
"readOnly": true
},
"isEmailTemplateEditable": {
"type": "boolean",
"example": true,
"description": "Indicates whether the email template can be editted.",
"readOnly": true
}
}
},
"type": {
"type": "object",
"description": "The type of the event",
"readOnly": true,
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Verlofaanvraag behandeld (voor de indiener)",
"description": "The description of the event."
},
"sortOrder": {
"type": "integer",
"example": 210,
"description": "A number used to sort the list."
}
}
},
"category-2": {
"type": "object",
"description": "The category to which the event belongs",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"example": 3,
"description": "The id of the categorie to which the event belongs."
},
"value": {
"type": "string",
"example": "Verlof",
"description": "The name of the categorie to which the event belongs."
}
}
},
"dependsOnModule": {
"type": "object",
"description": "The module to which the event belongs",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The id of the module to which the event belongs."
},
"description": {
"type": "string",
"example": "Verlof",
"description": "The name of the module to which the event belongs."
}
}
},
"definedAtLevel": {
"type": [
"string",
"null"
],
"enum": [
"Provider",
"PayrollAdministration"
],
"example": "Provider",
"description": "The level at which the event is defined. In the 'ByProvider' endpoints the payroll administration level is not used.",
"readOnly": true
},
"emailAddress-2": {
"type": [
"string",
"null"
],
"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])))$",
"example": "info@loket.nl",
"description": "The e-mail address that will receive the notification. It is possible to configure multiple addresses by dividing them with a ;",
"maxLength": 6000,
"readOnly": false
},
"eventNotification": {
"properties": {
"type": {
"$ref": "#/components/schemas/type"
},
"category": {
"$ref": "#/components/schemas/category-2"
},
"dependsOnModule": {
"$ref": "#/components/schemas/dependsOnModule"
},
"definedAtLevel": {
"$ref": "#/components/schemas/definedAtLevel"
},
"emailAddress": {
"$ref": "#/components/schemas/emailAddress-2"
}
}
},
"emailAddressNonNullable": {
"type": "string",
"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])))$",
"example": "info@loket.nl",
"description": "The e-mail address that will receive the notification. It is possible to configure multiple addresses by dividing them with a ;",
"maxLength": 6000,
"readOnly": false
},
"eventNotificationPut": {
"properties": {
"type": {
"$ref": "#/components/schemas/type"
},
"category": {
"$ref": "#/components/schemas/category-2"
},
"dependsOnModule": {
"$ref": "#/components/schemas/dependsOnModule"
},
"definedAtLevel": {
"$ref": "#/components/schemas/definedAtLevel"
},
"emailAddress": {
"$ref": "#/components/schemas/emailAddressNonNullable"
}
}
},
"applicationAuthorizations": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"activity": {
"type": "string",
"example": "GetEmployersByUserId",
"description": "name of the activity",
"maxLength": 50,
"readOnly": true
},
"displayName": {
"type": "string",
"example": "Lijst werkgevers",
"description": "description of the activity",
"maxLength": 50,
"readOnly": true
},
"requiredEmployerModules": {
"type": "array",
"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": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Personeelsregistratie",
"description": "description of the authorization (recht in loket)",
"maxLength": 50,
"readOnly": true
}
}
}
},
"requiredUserAuthorizations": {
"type": "array",
"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": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Beheren dienstverbanden",
"description": "description of the authorization (recht in loket)",
"maxLength": 50,
"readOnly": true
},
"availableForEmployerUser": {
"type": "boolean",
"description": "Indicates if the authorization is available for an employer user",
"example": true,
"readOnly": true
}
}
}
},
"allowedRoles": {
"type": "array",
"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": {
"id": {
"$ref": "#/components/schemas/id"
},
"description": {
"type": "string",
"example": "Provider",
"description": "description of the role",
"maxLength": 50,
"readOnly": true
}
}
}
}
}
},
"application": {
"type": "object",
"readOnly": true,
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"example": "ABC international",
"maxLength": 100,
"readOnly": true
},
"logo": {
"type": [
"string",
"null"
],
"example": "https://api.loket.nl/v2/applications/{applicationId}/logo/{version}",
"description": "An URI to the logo of the application",
"readOnly": true
},
"marketplaceDescription": {
"type": [
"string",
"null"
],
"example": "ABC international is the worlds leading etc.",
"description": "A description of the application. The description must be in HTML.",
"readOnly": true
},
"marketplaceSummary": {
"type": [
"string",
"null"
],
"example": "World-leading application for excellent employers",
"description": "A short summary of the application. The description must be in plain text.",
"maxLength": 200,
"readOnly": true
},
"website": {
"type": [
"string",
"null"
],
"example": "https://application.nl",
"description": "An URI to the website of the application",
"readOnly": true
},
"activationUrl": {
"type": [
"string",
"null"
],
"example": "https://application.nl",
"description": "An URI to a webpage of the application where the user can initiate the integration.",
"readOnly": true
},
"applicationTypes": {
"type": "array",
"description": "The type of software e.g. planning or finiance.",
"items": {
"type": "object",
"properties": {
"key": {
"$ref": "#/components/schemas/id"
},
"value": {
"readOnly": true,
"example": "planning",
"description": "Example values: - arbeidsvoorwaarden - data-analyse - document management - financieel - integratie - pensioenuitvoerder - planning - portal - proces - rapportage - tijdregistratie - verzuim/verzekering"
}
}
}
},
"targetIndustries": {
"type": "array",
"description": "The industries for which the software is primarily used",
"items": {
"type": "object",
"properties": {
"key": {
"$ref": "#/components/schemas/id"
},
"value": {
"type": "string",
"readOnly": true,
"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 "
}
}
}
},
"dateAddedToStore": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2021-12-31",
"description": "The date to which the application was added to the store",
"readOnly": false
},
"isHighlighted": {
"type": "boolean",
"example": true,
"description": "Indicates whether the application is highlighted (shown at the top of the list by default)",
"readOnly": true
},
"isActivatedForEmployer": {
"type": "boolean",
"example": true,
"description": "Indicates whether the application is configured for the given employer.\nIf 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)",
"readOnly": true
},
"productType": {
"type": "object",
"format": "metadata",
"description": "The type of marketplace offer",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the product type. Possible values:\n\n 1.\tKoppeling\n 2.\tModule",
"readOnly": false
},
"value": {
"type": "string",
"example": "Koppeling",
"description": "Description of the product.",
"maxLength": 50,
"readOnly": true
}
}
}
}
},
"linkedUsers-2": {
"type": "object",
"properties": {
"createdOn": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time the integration was successfully initiated",
"readOnly": true
},
"lastLogin": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The last time the integration was active",
"readOnly": true
},
"isblocked": {
"type": "boolean",
"example": true,
"description": "Indicates whether this specific user application link is blocked",
"readOnly": false
},
"user": {
"$ref": "#/components/schemas/userBasic"
}
}
},
"registerInterest": {
"type": "object",
"properties": {
"contactInformation": {
"type": "object",
"description": "Allows the user to provider contact information",
"readOnly": false,
"properties": {
"name": {
"type": "string",
"example": "G.H. Wells",
"description": "Name of person to contact",
"maxLength": 256,
"readOnly": false
},
"phoneNumber": {
"type": [
"string",
"null"
],
"example": "061231456",
"description": "The phone number to contact the user on.",
"maxLength": 15,
"readOnly": false
},
"emailAddress": {
"type": "string",
"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])))$",
"example": "info@loket.nl",
"description": "The e-mail address of the user.",
"maxLength": 255,
"readOnly": false
}
}
},
"message": {
"type": [
"string",
"null"
],
"example": "Could you contact me to discuss the possibilities of the product in my business ",
"description": "message for the intereseted user to the provider of the marketplace entity (product)",
"maxLength": 4000,
"readOnly": false
}
}
},
"field": {
"type": "object",
"format": "metadata",
"description": "The application that performed the mutation\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the field",
"readOnly": true
},
"value": {
"type": "string",
"example": "Achternaam",
"description": "Description of the field",
"maxLength": 50,
"readOnly": true
}
}
},
"oldValue": {
"type": [
"string",
"null"
],
"example": "Hermanss",
"description": "The value befor the change. \nIncase of an create the oldValue will be NULL.",
"maxLength": 250,
"readOnly": true
},
"newValue": {
"type": [
"string",
"null"
],
"example": "Hermans",
"description": "The value of the field after the change. \nIncase of an delete the nieuwValue will be NULL.",
"maxLength": 250,
"readOnly": true
},
"timeStamp": {
"type": "string",
"format": "date-time",
"example": "2018-05-08T15:16:49+02:00",
"description": "The time the mutation was performed",
"readOnly": true
},
"entity": {
"type": "object",
"format": "metadata",
"description": "The table on which the change took place\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the entity",
"readOnly": false
},
"value": {
"example": "employee",
"description": "Description of table",
"maxLength": 50,
"readOnly": true
}
}
},
"mutationType": {
"type": "object",
"format": "metadata",
"description": "The type of mutation\n\n\n * create (toevoegen)\n * update (wijzigen)\n * delete (verwijderen)\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the mutationType",
"readOnly": false
},
"value": {
"type": "string",
"example": "toevoegen",
"description": "Description of the mutationType",
"maxLength": 50,
"readOnly": true
}
}
},
"mutationOrigin": {
"type": "object",
"format": "metadata",
"description": "The origin of the mutation\nFor example:\n* By user * Automatich process * Collective change * Import\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the mutationOrigin",
"readOnly": false
},
"value": {
"type": "string",
"example": "Import",
"description": "Description of the mutationOrigin",
"maxLength": 50,
"readOnly": true
}
}
},
"employer-3": {
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "The unique identifier (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"employerNumber": {
"type": "integer",
"format": "int32",
"example": 20720,
"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).",
"readOnly": true
},
"companyName": {
"type": "string",
"example": "Voorbeeld B.V.",
"description": "Name of the company",
"maxLength": 70,
"readOnly": false
}
}
},
"identification": {
"type": [
"object",
"null"
],
"description": "The identification of the entity record that was changed\n",
"properties": {
"description": {
"type": [
"string",
"null"
],
"example": "Datum ingang 03-03-2005",
"description": "Extra identifying information for the mutation",
"maxLength": 255,
"readOnly": true
}
}
},
"employerAuditTrail": {
"type": "object",
"properties": {
"field": {
"$ref": "#/components/schemas/field"
},
"oldValue": {
"$ref": "#/components/schemas/oldValue"
},
"newValue": {
"$ref": "#/components/schemas/newValue"
},
"timeStamp": {
"$ref": "#/components/schemas/timeStamp"
},
"entity": {
"$ref": "#/components/schemas/entity"
},
"performedBy": {
"$ref": "#/components/schemas/userBasic"
},
"mutationType": {
"$ref": "#/components/schemas/mutationType"
},
"mutationOrigin": {
"$ref": "#/components/schemas/mutationOrigin"
},
"employer": {
"$ref": "#/components/schemas/employer-3"
},
"identification": {
"$ref": "#/components/schemas/identification"
}
}
},
"employee-4": {
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "The unique identifier (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"employeeNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 156,
"description": "The employee number to uniquely identify a employee within an employer.",
"readOnly": true
},
"name": {
"type": [
"string",
"null"
],
"example": "Bergen",
"description": "The name of the employee",
"maxLength": 25,
"readOnly": true
}
}
},
"employment-4": {
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "The unique identifier (GUID/UUID)",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"startDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-01-01",
"description": "The date on which this employment starts.",
"readOnly": true
}
}
},
"administration-2": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"description": "`payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"name": {
"type": [
"string",
"null"
],
"example": "ABC accountants",
"description": "Name of the payroll administration",
"maxLength": 70,
"readOnly": true
},
"clientNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 1234,
"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.",
"readOnly": true
},
"description": {
"type": "string",
"example": "Bakker",
"description": "Description of the administration",
"maxLength": 50,
"readOnly": true
},
"administrationType": {
"type": "string",
"enum": [
"payrollAdministration",
"nonPayrollAdministration"
],
"description": "The type of administration",
"readOnly": true
}
}
},
"employeeAuditTrail": {
"type": "object",
"properties": {
"field": {
"$ref": "#/components/schemas/field"
},
"oldValue": {
"$ref": "#/components/schemas/oldValue"
},
"newValue": {
"$ref": "#/components/schemas/newValue"
},
"timeStamp": {
"$ref": "#/components/schemas/timeStamp"
},
"entity": {
"$ref": "#/components/schemas/entity"
},
"performedBy": {
"$ref": "#/components/schemas/userBasic"
},
"mutationType": {
"$ref": "#/components/schemas/mutationType"
},
"mutationOrigin": {
"$ref": "#/components/schemas/mutationOrigin"
},
"employer": {
"$ref": "#/components/schemas/employer-3"
},
"employee": {
"$ref": "#/components/schemas/employee-4"
},
"employment": {
"$ref": "#/components/schemas/employment-4"
},
"identification": {
"$ref": "#/components/schemas/identification"
},
"administration": {
"$ref": "#/components/schemas/administration-2"
}
}
},
"payrollComponentCategory": {
"type": [
"object",
"null"
],
"format": "metadata",
"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.\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "Ulsa.Component.Categorie"
},
"value": {
"type": "string",
"example": "Uren",
"readOnly": true,
"x-loket-db-field": "dbo.ctCategorie.omschrijving"
}
}
},
"payrollAdministration-2": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"example": "ABC accountants",
"description": "Name of the administration",
"maxLength": 70,
"readOnly": false,
"x-loket-db-field": "Ulsa.Werkgever.Naam"
},
"clientNumber": {
"type": "integer",
"format": "int32",
"example": 1234,
"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.",
"readOnly": true
}
}
},
"identificationPayrollPeriodData": {
"type": [
"object",
"null"
],
"description": "The identification of the entity record that was changed\n",
"properties": {
"id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "The ID of the entity record that was changed",
"example": "904d6856-6034-4624-bcbc-886188c115c5"
},
"payrollPeriod": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"x-loket-implementation": "De twee waardes kunnen vertaald worden naar Loket.Loontransactie.PeriodeID dan zal er wel voor gezorgd moeten worden dat periode altijd uit 2 cijfers bestaat het is nu een int dus mogelijk moet periode een number worden",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period in which the payroll data is to be processed\n",
"example": 2017,
"minimum": 2000,
"maximum": 9999,
"readOnly": true,
"x-loket-db-field": "eerste 4 cijfers van Loket.Loontransactie.PeriodeID"
},
"periodNumber": {
"type": "integer",
"format": "int32",
"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.\n",
"example": 1,
"minimum": 1,
"maximum": 53,
"readOnly": true,
"x-loket-db-field": "Laatste 2 cijfers van Loket.Loontransactie.PeriodeID",
"x-loket-implementation": "Bij het updaten/inserten van dit veld eventueel een leading 0 toevoegen aan het periodenummer als deze kleiner is dan 10. Zodat PeriodeID in de database altijd 6 cijfers bevat met als formatting yyyymm, bijvoorbeeld 201807"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the period to which the payroll period data applies\n",
"example": "2018-01-01",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the period to which the payroll period data applies\n",
"example": "2018-01-31",
"readOnly": true,
"x-loket-implementation": "De waarde van dit veld wordt bepaald op basis van werkgever, jaar en periode. Een voorbeeld van hoe de datum opgehaald kan worden is te zien in de stored procedure Loket.prcVerloningsRunList. Hier wordt de stored procedure Ulsa.prcVerloningsPeriodeListILoket aangeroepen om de start- en einddatum van een periode te bepalen."
}
}
},
"shift": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The shift determines the full-time hours and bonus percentage.\n",
"properties": {
"shiftNumber": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number for the shift. Loket supports a maximum of 15 shifts per payroll administration.\n",
"readOnly": false,
"x-loket-db-field": "Ulsa.Ploeg.PloegId",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. Let wel op dat het ID meerdere malen voor kan komen in Ulsa omdat het daar uniek is in combinatie met verlongingsperiodeID"
},
"fullTimeHoursPerWeek": {
"type": "number",
"example": 40,
"description": "The full time hours for an employment that is linked to this shift.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.Ploeg.Uren"
},
"bonusPercentage": {
"type": "number",
"example": 12,
"description": "The bonus percentage used in wage calculations for the hours made in this shift.\n",
"readOnly": true,
"x-loket-db-field": "Ulsa.Ploeg.Percentage"
}
}
},
"payslipType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The type of payslip (as defined by the Dutch tax authorities)\n",
"readOnly": true,
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.Loontransactie.Strook"
},
"value": {
"type": "string",
"example": "Bijzonder tarief strook",
"readOnly": true,
"x-loket-db-field": "dbo.ctStrook.Omschrijving"
}
}
},
"distributionUnit": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Distribution unit, used in several reports and the \"basic wage journal\" functionality. Commonly used as a cost center.\n",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": false,
"x-loket-db-field": "Loket.VerdelingsEenheid.ExternId"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.Nummer"
},
"description": {
"type": "string",
"example": "Sales",
"readOnly": true,
"x-loket-db-field": "Loket.VerdelingsEenheid.Omschrijving"
}
}
},
"costCenter": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost center on which the payroll period data for this record will be booked for the ledger.\n",
"x-loket-implementation": "er zit overerving in de logica voor het ophalen van de waardes van de kostenplaats. null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.KostenplaatsID",
"x-loket-implementation": "Kan geen GUID zijn vanwege de overerving. De code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "SAL073",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Sales Den Bosch",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostenplaats.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"costUnit": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The cost unit on which the data for this record will be booked for the ledger\n",
"x-loket-implementation": "er zit overerving in de logica voor het ophalen van de waardes van de kostendrager. null = 0 (leeg) zowel bij uitlezen als opslaan.",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "Loket.Loontransactie.KostenDragerID",
"x-loket-implementation": "Kan geen GUID zijn vanwegen de overerving. en code is niet uniek en een varchar daarom het database ID"
},
"code": {
"type": "string",
"example": "01",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Code",
"x-loket-implementation": "Let op dit betreft een view!"
},
"description": {
"type": "string",
"example": "Cars",
"readOnly": true,
"x-loket-db-field": "Ulsa.Kostendrager.Omschrijving",
"x-loket-implementation": "Let op dit betreft een view!"
}
}
},
"description": {
"type": [
"string",
"null"
],
"example": "Datum ingang 03-03-2005",
"description": "Extra identifying information for the mutation",
"maxLength": 255,
"readOnly": true
}
}
},
"payrollPeriodDataAuditTrail": {
"type": "object",
"properties": {
"field": {
"$ref": "#/components/schemas/field"
},
"payrollComponentCategory": {
"$ref": "#/components/schemas/payrollComponentCategory"
},
"oldValue": {
"$ref": "#/components/schemas/oldValue"
},
"newValue": {
"$ref": "#/components/schemas/newValue"
},
"timeStamp": {
"$ref": "#/components/schemas/timeStamp"
},
"performedBy": {
"$ref": "#/components/schemas/userBasic"
},
"mutationType": {
"$ref": "#/components/schemas/mutationType"
},
"mutationOrigin": {
"$ref": "#/components/schemas/mutationOrigin"
},
"employer": {
"$ref": "#/components/schemas/employer-3"
},
"payrollAdministration": {
"$ref": "#/components/schemas/payrollAdministration-2"
},
"employee": {
"$ref": "#/components/schemas/employee-4"
},
"employment": {
"$ref": "#/components/schemas/employment-4"
},
"identification": {
"$ref": "#/components/schemas/identificationPayrollPeriodData"
}
}
},
"applicationSet": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"applicationSetType": {
"type": "string",
"enum": [
"Products",
"ExportDataTemplate",
"Rights"
],
"description": "The type of the set \n",
"readOnly": false
},
"name": {
"type": "string",
"example": "Exportset Dienstverband",
"description": "Name of the exportset\n",
"maximum": 50,
"readOnly": false
},
"data": {
"type": "string",
"example": "json object",
"description": "Contains an array of objects in json structure.\n",
"readOnly": false
},
"createdBy": {
"type": [
"object",
"null"
],
"description": "The user who created the applicationset. Is empty for Loket templates.\n",
"readOnly": true,
"properties": {
"id": {
"$ref": "#/components/schemas/id"
}
}
}
}
},
"applicationSetPut": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"applicationSetType": {
"type": "string",
"enum": [
"Products",
"ExportDataTemplate",
"Rights"
],
"description": "The type of the set \n",
"readOnly": true
},
"name": {
"type": "string",
"example": "Exportset Dienstverband",
"description": "Name of the exportset\n",
"maximum": 50,
"readOnly": false
},
"data": {
"type": "string",
"example": "json object",
"description": "Contains an array of objects in json structure.\n",
"readOnly": false
}
}
},
"payrollSimulatorData": {
"type": "object",
"properties": {
"wage": {
"type": "object",
"properties": {
"currentWage": {
"type": [
"number",
"null"
],
"format": "double",
"example": 2300,
"description": "The gross wage for the employee\n",
"minimum": 0.01,
"maximum": 999999.99,
"readOnly": true,
"x-loket-implementation": "In het geval van een 0 NULL teruggeven"
},
"type": {
"type": "object",
"format": "metadata",
"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.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.Beloning.BasisloonEenheid"
},
"value": {
"type": "string",
"example": "hourly",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisloonEenheid"
}
}
},
"class": {
"type": "string",
"enum": [
"Basisloon",
"Nettoloon",
"Loonkosten"
],
"maxLength": 255,
"example": "Basisloon",
"description": "The class of the wage",
"readOnly": true
}
}
},
"payrollPeriodType": {
"type": "object",
"readOnly": true,
"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).",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.code"
},
"value": {
"type": "string",
"example": "month",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctSoortVerloning.omschrijving"
}
}
},
"workingHours": {
"type": "object",
"properties": {
"currentHoursPerWeek": {
"type": [
"number",
"null"
],
"example": 41,
"description": "The hours per week de employment currently works",
"readOnly": true
},
"shift": {
"type": "object",
"description": "The shift determines the full-time hours and bonus percentage.\n\n`shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.\n",
"properties": {
"fullTimeHoursPerWeek": {
"type": "number",
"example": 40,
"description": "The full time hours for an employment that is linked to this shift.\n",
"minimum": 0.01,
"maximum": 99,
"readOnly": true
}
}
}
}
},
"startDateDeviations": {
"type": "string",
"format": "date",
"example": "2022-08-01",
"description": "The date to be used when calling the wageprojection endpoint",
"readOnly": true
}
}
},
"EmailIdentity": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"emailIdentity": {
"type": "string",
"example": "provider.com",
"description": "The emailIdentity that can be used when sending email.",
"readOnly": false
},
"emailIdentityType": {
"type": "string",
"enum": [
"DOMAIN"
],
"description": "The type of the set emailIdentity",
"readOnly": true
},
"isSpfVerified": {
"type": "boolean",
"example": true,
"description": "Indicates whether the EmailIdentity has passed Spf verfication.",
"readOnly": true
},
"isDkimVerified": {
"type": "boolean",
"example": true,
"description": "Indicates whether the EmailIdentity has passed Spf verfication.",
"readOnly": true
},
"lastDkimVerifiedOn": {
"type": "string",
"format": "date",
"description": "The date the Dkim settings were last verified.",
"example": "2022-01-31",
"readOnly": true
},
"lastSpfVerifiedOn": {
"type": "string",
"format": "date",
"description": "The date the Spf settings were last verified.",
"example": "2022-01-31",
"readOnly": true
},
"dkimTokens": {
"type": [
"array",
"null"
],
"readOnly": true,
"items": {
"type": "string",
"example": "u6deqmqhlgn3wxslcp4cugcz7ognh4gt",
"description": "The Tokens which should be registred"
}
}
}
},
"EmailIdentityTestEmail": {
"type": [
"object",
"null"
],
"properties": {
"to": {
"type": "string",
"example": "user@provider.com",
"description": "The emailadres to which a test email should be send.",
"readOnly": false
}
}
},
"conceptemployeeDetails": {
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity",
"example": "904d6856-6034-4624-bcbc-886188c115c5",
"readOnly": true
},
"index": {
"type": "integer",
"format": "int32",
"example": 2,
"minimum": 1,
"description": "The location of the employee in the import file. The index start with 1 for the first employment in the file\n",
"readOnly": true
},
"formattedName": {
"type": [
"string",
"null"
],
"example": "Jong, I",
"description": "preformatted user name for displaying. \\\\\", \\\"\\\\\" \\\"\\",
"readOnly": true
},
"employeeNumber": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 156,
"minimum": 1,
"description": "The employee number to uniquely identify an employee within an employer\n",
"readOnly": true
}
}
},
"patchResponse": {
"type": "object",
"properties": {
"successfull": {
"type": "array",
"items": {
"$ref": "#/components/schemas/conceptemployeeDetails"
}
},
"failed": {
"type": "array",
"items": {
"$ref": "#/components/schemas/conceptemployeeDetails"
}
}
}
},
"payScale": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "A pay scale (also known as a salary structure) is a system that determines how much an employee is to be paid as a wage or salary, based on one or more factors such as the employee\"s level, rank or status within the employer\"s organization, the length of time that the employee has been employed, and the difficulty of the specific work performed. After selecting a pay scale a pay grade needs to be selected to determine the actual wage. Only works with `grossWage`. The value of `grossWage` will be updated server side after the submit.\n\n`payScale` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "loket.Beloning.Salarisschaal"
},
"value": {
"type": "string",
"example": "Glastuinbouw maand, Loongebouw A",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Ulsa.Salarisschaal",
"x-loket-implementation": "Dit veld is ADM specifiek en bij het ophalen moet ook gekeken worden naar welke waardes voor de administratie beschikbaar zijn."
}
}
},
"grossWageType": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "Indicates whether the `grossWage` is an hourly wage or a periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in wagePeriodType.\n",
"x-loket-implementation": "In het geval dat grossWage NULL is dit veld ook op NULL stellen",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.BasisloonEenheid"
},
"value": {
"type": "string",
"example": "hourly",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "dbo.ctBasisloonEenheid"
}
}
},
"payGrade-2": {
"type": [
"object",
"null"
],
"format": "metadata",
"description": "The pay grade indicates on what level (cel) of the paygrade the employment is. The level is multi dimensional where the description indicates both the level and for example the number of years of service within the given level. \n\n`payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.\n",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": true,
"x-loket-db-field": "loket.Beloning.SalarisschaalCelID"
},
"value": {
"type": "string",
"example": "Schaal B1, 15 jaar",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "ulsa.SalarisschaalCel",
"x-loket-implementation": "Dit veld is ADM specifiek en bij het ophalen moet ook gekeken worden naar welke waardes voor de administratie beschikbaar zijn."
}
}
},
"grossWage": {
"type": [
"number",
"null"
],
"format": "double",
"example": 23,
"description": "The gross wage for the employee\n",
"minimum": 1,
"maximum": 1000000,
"readOnly": false,
"x-loket-db-field": "loket.ConceptWerknemer.Basisloon",
"x-loket-implementation": "In het geval van een 0 NULL teruggeven"
},
"wageProposalObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"payScale": {
"$ref": "#/components/schemas/payScale"
},
"grossWageType": {
"$ref": "#/components/schemas/grossWageType"
},
"currentPayGrade": {
"$ref": "#/components/schemas/payGrade-2"
},
"currentGrossWage": {
"$ref": "#/components/schemas/grossWage"
},
"proposedPayGrade": {
"$ref": "#/components/schemas/payGrade-2"
},
"proposedGrossWage": {
"$ref": "#/components/schemas/grossWage"
},
"startDateProposal": {
"type": "string",
"format": "date",
"example": "2017-11-01",
"description": "The date to which the declaration is applicable. As requested by the employee.",
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerMutatie.Datum"
},
"proposalReason": {
"type": [
"object",
"null"
],
"format": "metadata",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The key of the reason",
"readOnly": false
},
"value": {
"type": "string",
"example": "Birthday",
"description": "The description of the reasson for the proposal",
"readOnly": true
}
}
},
"status": {
"type": "object",
"readOnly": true,
"format": "metadata",
"description": "The current status of the wage proposal\n\nThe status is changed by using the PATCH endpoint.\n\n1. Voorgesteld --> Accept or reject\n2. Goedgekeurd ---> No changes possible\n3. Afgekeurd ---> No changes possible\n5. Niet verwerkbaar ---> No changes possible",
"properties": {
"key": {
"type": "integer",
"format": "int32",
"example": 1,
"readOnly": false,
"x-loket-db-field": "Loket.WerknemerMutatie.Status"
},
"value": {
"type": "string",
"example": "Open",
"readOnly": true,
"x-loket-db-field": "dbo.ctWerknemerMutatieStatus.Omschrijving"
}
}
},
"employmentInformation": {
"type": "object",
"readOnly": true,
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"employeeNumber": {
"type": "integer",
"format": "int32",
"example": 156,
"minimum": 1,
"description": "The employee number to uniquely identify an employee within an employer\n",
"readOnly": true,
"x-loket-db-field": "Loket.Persoon.Personeelsnummer"
},
"firstName": {
"type": [
"string",
"null"
],
"example": "Susan",
"description": "The first name, given name, forename or Christian name as part of a persons personal name.\n",
"minLength": 1,
"maxLength": 28,
"readOnly": true,
"x-loket-db-field": "Loket.(Persoon/Partner/Kind).Roepnaam"
},
"formattedName": {
"type": "string",
"example": "Wiel - van Bergen S.L. van de",
"description": "Formatted name of the employee based on the value of `howToFormatLastName`",
"maxLength": 82,
"readOnly": true,
"x-loket-implementation": "Dit veld is een samenvoegsel van de losse naam elementen. De logica voor het opbouwen van de naam is gelijk aan de logica in Loket.vwVolledigeNaam"
},
"incomeRelationshipNumber": {
"type": "integer",
"format": "int32",
"example": 12,
"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.",
"minimum": 0,
"maximum": 9999,
"readOnly": true,
"x-loket-db-field": "Loket.Dienstverband.NummerInkomstenVerhouding"
},
"photo": {
"type": [
"string",
"null"
],
"format": "url",
"example": "https://api.loket.nl/v2/v2/providers/employers/employees/{employeeId}/photo/{version}",
"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.",
"readOnly": true
},
"payrollAdministration": {
"type": [
"object",
"null"
],
"format": "metadata",
"readOnly": true,
"description": "Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time)\n\n`payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)",
"pattern": "^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true,
"x-loket-implementation": "Komt uit ulsa.werkgever ipv loket.verloning"
},
"name": {
"type": "string",
"example": "ABC accountants",
"description": "Name of the payroll administration",
"maxLength": 70,
"readOnly": true,
"x-loket-db-field": "Ulsa.Werkgever.Naam --> Dit is anders als wat we nu doen nu komt de naam uit loket.verloning.Omschrijving"
},
"clientNumber": {
"type": "integer",
"format": "int32",
"example": 1234,
"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.",
"readOnly": true,
"x-loket-db-field": "Ulsa.Werkgever.ClientNummer & Loket.Verloning.ClientNr",
"x-loket-implementation": "Het clientnummer is de verbinding tussen Ulsa.Werkgever en Loket.Verloning. Een waarde 0 in de database wordt als NULL teruggegeven in de API."
},
"description": {
"type": "string",
"example": "Bakker",
"description": "Description of the administration",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.Verloning.Omschrijving"
}
}
},
"function": {
"type": "object",
"format": "metadata",
"description": "The function of the employment.\n\n`function` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true,
"x-loket-db-field": "loket.WerknemerFunctie.FunctieID en dan in loket.functie het externId ophalen"
},
"description": {
"type": "string",
"example": "Directeur",
"maxLength": 50,
"readOnly": true,
"x-loket-db-field": "Loket.Functie.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.Functie bevat de functies voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
},
"group": {
"type": [
"string",
"null"
],
"example": "internal",
"maxLength": 5,
"readOnly": true,
"x-loket-db-field": "Loket.Functie.functiegroup",
"x-loket-implementation": "Let op: de tabel Loket.Functie bevat de functies voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
},
"department": {
"x-loket-implementation": "kijk naar organisatorische eenheid regel met grootste startdatum",
"type": "object",
"format": "metadata",
"description": "The department of the employment.\n\n`department` is a metadata field within the employer context. Possible values can be managed by the user.",
"properties": {
"key": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true,
"x-loket-db-field": "loket.WerknemerFunctie.Afdeling omzetten naar guid"
},
"code": {
"type": "integer",
"format": "int32",
"example": 2,
"readOnly": true,
"x-loket-db-field": "Loket.Afdeling.code"
},
"description": {
"type": "string",
"example": "Verkoop",
"readOnly": true,
"x-loket-db-field": "Loket.Afdeling.Omschrijving",
"x-loket-implementation": "Let op: de tabel Loket.Afdeling bevat de afdelingen voor alle werkgevers. Filteren op werkgever is dus noodzakelijk."
}
}
}
}
}
}
},
"wageProposalPatchObject": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "The unique identifier (a GUID/UUID)",
"readOnly": false
},
"action": {
"type": "string",
"enum": [
"accept",
"reject"
],
"description": "The action to perform on the wage proposal resulting in a change of `status`\nThe following transitions are allowed\n1. Voorgesteld --> Accept or reject\n2. Goedgekeurd ---> No changes possible\n3. Afgekeurd ---> No changes possible\n5. Niet verwerkbaar ---> No changes possible",
"readOnly": false
}
},
"required": [
"id",
"action"
]
},
"MdvMeldingen": {
"properties": {
"employee": {
"type": "object",
"readOnly": true,
"properties": {
"citizenServiceNumber": {
"$ref": "#/components/schemas/citizenServiceNumber"
},
"initials": {
"$ref": "#/components/schemas/initials-2"
},
"prefix": {
"$ref": "#/components/schemas/prefix"
},
"lastName": {
"$ref": "#/components/schemas/lastName"
},
"gender": {
"type": "string",
"example": "M",
"description": "gender indication",
"maxLength": 1,
"readOnly": true
},
"dateOfBirth": {
"$ref": "#/components/schemas/dateOfBirth"
}
}
},
"employment": {
"type": "object",
"readOnly": true,
"properties": {
"startDate": {
"type": "string",
"format": "date",
"example": "2018-01-01",
"description": "The date on which this employment starts.",
"readOnly": true,
"x-loket-db-field": "Loket.Dienstverband.DatumInDienst"
},
"endDate": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2018-10-23",
"description": "The date on which the employment ends.",
"readOnly": true,
"x-loket-db-field": "Loket.Dienstverband.DatumUitDienst"
},
"claExternalParty": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": 2,
"description": "CLA (CAO) code in case of a deviating CLA for external parties . NL: CaoKlantgroepAfwijkend",
"readOnly": false,
"x-loket-db-field": "Loket.Dienstverband.CaoKlantgroepAfwijkend",
"x-loket-implementation": "als NULL dan 0 voor database"
}
}
},
"payrollAdministration": {
"type": "object",
"readOnly": true,
"properties": {
"payrollTaxesNumber": {
"type": [
"string",
"null"
],
"example": "111111110L46",
"minLength": 12,
"maxLength": 12,
"description": "The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst.",
"readOnly": false,
"x-loket-db-field": "Ulsa.Werkgever.LoonheffingenNummer"
}
}
}
}
},
"initializeProforma": {
"type": "object",
"properties": {
"proformaType": {
"type": "string",
"enum": [
"WithSalaryResultsWithSalaryVariables",
"WithSalaryResultsWithoutSalaryVariables",
"WithoutSalaryResultsWithSalaryVariables",
"WithoutSalaryResultsWithoutSalaryVariables",
"WithoutEmployments"
]
},
"employeeId": {
"type": [
"string",
"null"
],
"format": "uuid",
"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.\n\nDoes not work in combination with `proformaType` = \"Zonder dienstverbanden\"",
"example": "904d6856-6034-4624-bcbc-886188c115c5",
"readOnly": false
}
}
},
"proformaStatus": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"Inactive",
"Data transfer in progress",
"Active"
]
},
"activeFor": {
"$ref": "#/components/schemas/userBasic"
}
}
},
"workRelatedCostsSchemeFinancialsObject": {
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"year": {
"type": "integer",
"format": "int32",
"description": "The year the record relates to\n",
"example": 2023,
"minimum": 2011,
"maximum": 2099,
"readOnly": false
},
"period": {
"type": "integer",
"format": "int32",
"description": "The period the record relates to\n",
"example": 1,
"minimum": 1,
"maximum": 53,
"readOnly": false
},
"identification": {
"type": "string",
"example": "Company bike",
"maxLength": 50,
"description": "The identification for a work related costs scheme financial",
"readOnly": false
},
"description": {
"type": "string",
"example": "Sparta d-RULE ULTRA",
"maxLength": 50,
"description": "The description for a work related costs scheme financial",
"readOnly": false
},
"amount": {
"type": "number",
"description": "The amount of the given record ",
"pattern": "^(\\d{1,15})(.\\d{1,2})?$",
"minimum": 0.01,
"maximum": 922337203685477,
"example": 3500,
"readOnly": false
}
}
},
"workRelatedCostsSchemeMatrixObject": {
"type": "object",
"properties": {
"payrollPeriod": {
"type": "object",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period",
"example": 2017,
"readOnly": true
},
"periodNumber": {
"type": "integer",
"format": "int32",
"description": "The period number of the payroll period",
"example": 1,
"readOnly": true
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "The first day of the payroll period",
"example": "2018-01-01",
"readOnly": true
},
"periodEndDate": {
"type": "string",
"format": "date",
"description": "The last day of the payroll period",
"example": "2018-01-31",
"readOnly": true
}
}
},
"discretionaryScopeCumulative": {
"type": [
"number",
"null"
],
"description": "The amount of the given record ",
"pattern": "^(\\d{1,14})(.\\d{1,2})?$",
"minimum": 0.01,
"example": 3500,
"readOnly": true
},
"workRelatedCostsCumulative": {
"type": [
"number",
"null"
],
"description": "The amount of the given record ",
"pattern": "^(\\d{1,14})(.\\d{1,2})?$",
"minimum": 0.01,
"example": 3500,
"readOnly": true
}
}
},
"modulesEmployersReport": {
"type": "object",
"properties": {
"employer": {
"$ref": "#/components/schemas/employer-2"
},
"payrollAdministration": {
"$ref": "#/components/schemas/payrollAdministration"
},
"moduleSet": {
"type": [
"object",
"null"
],
"description": "The module set is a collection of modules. It contains the id and description of the module set. It is prosible to deviate for the set by manualy enabling of disabling modules.\n",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of the module set (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"description": {
"type": "string",
"example": "Personeelsregistratie",
"readOnly": true,
"maxLength": 50
}
}
},
"modules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of an object (GUID/UUID)\n",
"pattern": "^[{(]?[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}[)}]?$",
"example": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"readOnly": true
},
"description": {
"type": "string",
"example": "Personeelsregistratie",
"readOnly": true,
"maxLength": 50
},
"number": {
"type": "number",
"format": "int32",
"description": "the module number",
"example": 40,
"readOnly": true
},
"isEnabled": {
"type": "boolean",
"description": "Indicates whether the module is enabled for the employer.\n",
"example": true,
"readOnly": true
}
}
}
},
"userHasAccess": {
"type": "boolean",
"description": "Indicates whether the user has access to the module for the employer.\n",
"example": true,
"readOnly": true
}
}
},
"YearEndStatementsReport": {
"type": "object",
"properties": {
"employer": {
"$ref": "#/components/schemas/employer-2"
},
"payrollAdministration": {
"$ref": "#/components/schemas/payrollAdministration"
},
"payrollYear": {
"type": "object",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year for which the report is generated. This is the year in which the payroll administration is active.",
"example": 2025,
"readOnly": true
},
"testYear": {
"type": "boolean",
"example": false,
"description": "Indicates whether the payroll year is a test year.\n\nIn 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.\nPlease 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.",
"readOnly": true,
"x-loket-db-field": "af te leiden uit de jaarinrichting van de administratie Ulsa.Jaar"
}
}
},
"numberOfYearEndStatements": {
"type": "integer",
"format": "int32",
"description": "The number of year-end statements that are generated for the payroll administration in the specified year.",
"example": 10,
"readOnly": true
},
"numberOfDismissalCompensationYearEndStatements": {
"type": "integer",
"format": "int32",
"description": "The number of dismissal compensation (Transition payment / transitievergoeding) year-end statements that are generated for the payroll administration in the specified year.",
"example": 10,
"readOnly": true
},
"numberOfActiveEmployments": {
"type": "integer",
"format": "int32",
"description": "The number of active employments in the payroll administration for the specified year on the given `referenceDate`.",
"example": 10,
"readOnly": true
}
}
},
"paySlips": {
"type": "object",
"properties": {
"employer": {
"$ref": "#/components/schemas/employer-2"
},
"payrollAdministration": {
"$ref": "#/components/schemas/payrollAdministration"
},
"payrollPeriods": {
"type": "array",
"items": {
"type": "object",
"properties": {
"year": {
"type": "integer",
"format": "int32",
"description": "The year of the payroll period.",
"example": 2025
},
"period": {
"type": "integer",
"format": "int32",
"description": "The payroll period number within the year.",
"example": 1
},
"testYear": {
"type": "boolean",
"example": false,
"description": "Indicates whether the payroll period belongs to 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."
},
"totalNumberOfPayslips": {
"type": "integer",
"format": "int32",
"description": "The total number of payslips generated for the payroll period.",
"example": 10
},
"numberOfNormalPayslips": {
"type": "integer",
"format": "int32",
"description": "The number of normal payslips generated for the payroll period.",
"example": 8
},
"numberOfSpecialRatePayslips": {
"type": "integer",
"format": "int32",
"description": "The number of special rate payslips generated for the payroll period.",
"example": 2
},
"numberOfRecalculatedPayslips": {
"type": "integer",
"format": "int32",
"description": "The number of recalculated payslips generated for the payroll period.",
"example": 1
}
}
}
},
"totalNumberOfPayslips": {
"type": "integer",
"format": "int32",
"description": "The total number of payslips for all payroll periods within the given scope.",
"example": 100
},
"numberOfNormalPayslips": {
"type": "integer",
"format": "int32",
"description": "The total number of normal payslips for all payroll periods within the given scope.",
"example": 80
},
"numberOfSpecialRatePayslips": {
"type": "integer",
"format": "int32",
"description": "The total number of special rate payslips for all payroll periods within the given scope.",
"example": 20
},
"numberOfRecalculatedPayslips": {
"type": "integer",
"format": "int32",
"description": "The total number of recalculated payslips for all payroll periods within the given scope.",
"example": 1
}
}
},
"employmentTurnover": {
"type": "object",
"properties": {
"employer": {
"$ref": "#/components/schemas/employer-2"
},
"payrollAdministration": {
"$ref": "#/components/schemas/payrollAdministration"
},
"nonPayrollAdministration": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"example": "Voorbeeld B.V. - Non payroll",
"description": "The name of the non-payroll administration. This is the name that is used in the Loket interface.",
"maxLength": 50,
"readOnly": true
}
}
},
"numberOfNewHires": {
"type": "integer",
"format": "int32",
"description": "The number employments that that started within the given scope.",
"example": 12
},
"numberOfTerminatedEmployments": {
"type": "integer",
"format": "int32",
"description": "The number of employments that been terminated within the given scope.",
"example": 1
},
"numberOfActiveEmployments": {
"type": "integer",
"format": "int32",
"description": "The number of active employments within the given scope.",
"example": 150
},
"numberOfInactiveEmployments": {
"type": "integer",
"format": "int32",
"description": "The number of inactive employments within the given scope.",
"example": 3
}
}
}
},
"responses": {
"badRequestCollection": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/paging"
},
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageBrokenBusinessRule-2"
},
{
"type": "object",
"properties": {
"_embedded": {
"type": "array",
"items": {
"properties": {}
}
}
}
}
]
}
}
}
},
"unauthorized": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Authorization has been denied for this request."
}
}
}
}
}
},
"forbidden": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\""
}
}
}
}
}
},
"notFound": {
"description": "Not Found"
},
"internalServerError": {
"description": "Internal Server Error"
},
"badRequestDetail": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageBrokenBusinessRule-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object",
"properties": {}
}
}
}
]
}
}
}
},
"conflict": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"version": {
"$ref": "#/components/schemas/version"
},
"messages": {
"$ref": "#/components/schemas/messageBrokenBusinessRule"
},
"content": {
"type": "object"
}
}
}
}
}
},
"deleteEmptyResponse": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageBrokenBusinessRule-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object",
"properties": {}
}
}
}
]
}
}
}
},
"acceptedResponse": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageBrokenBusinessRule-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object",
"properties": {}
}
}
}
]
}
}
}
},
"requestEntityTooLarge": {
"description": "The request is larger than the server is willing or able to process."
},
"unsupportedMediaType": {
"description": "The server refuses to accept the request because the payload format is in an unsupported format."
},
"async": {
"description": "Async download",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/version-2"
},
{
"$ref": "#/components/schemas/messageBrokenBusinessRule-2"
},
{
"type": "object",
"properties": {
"content": {
"type": "object",
"properties": {
"transactionId": {
"$ref": "#/components/schemas/id"
}
}
}
}
}
]
}
}
}
}
},
"headers": {
"ETag": {
"description": "The etag for concurrency control. If a PUT is performed this value has to be supplied in the if-match header of the request.\n",
"schema": {
"type": "string"
}
}
},
"examples": {
"withoutRoute": {
"value": {
"id": "744647c5-d4de-45e8-b490-5fc272f9f705",
"employmentInformation": {
"id": "c97e6441-b2ab-47ae-8daf-70dc088bcc68",
"employeeNumber": 7,
"firstName": "DeclaratieIndienen",
"formattedName": "DeclaratieIndienen QA",
"incomeRelationshipNumber": 1
},
"payrollComponent": {
"key": 1,
"description": "UREN GEWERKT",
"deviatingDescription": "gewerkte uren",
"deductionOrPayment": {
"key": 0,
"value": "n.v.t."
},
"routeType": null
},
"calculatedDistanceByRoutingService": null,
"numberOfUnits": 184.58,
"declarationDate": "declarationDateTime",
"declarationComment": "QA_DeclaratieIndienen - PostInitiateDeclarationWorkflowByEmploymentId - component 1 - 184.58",
"reasonForDeviatingFromCalculatedDistance": null,
"route": null
}
},
"withRoute": {
"value": {
"id": "41626bee-b82d-4a72-92a6-abd8f62e2115",
"employmentInformation": {
"id": "c97e6441-b2ab-47ae-8daf-70dc088bcc68",
"employeeNumber": 7,
"firstName": "DeclaratieIndienen",
"formattedName": "DeclaratieIndienen QA",
"incomeRelationshipNumber": 1
},
"payrollComponent": {
"key": 41,
"description": "KM.ONBELAST",
"deviatingDescription": null,
"deductionOrPayment": {
"key": 0,
"value": "n.v.t."
},
"routeType": {
"key": 1,
"value": "Snelste"
}
},
"calculatedDistanceByRoutingService": 6.89,
"numberOfUnits": 6.89,
"declarationDate": "declarationDateTime",
"declarationComment": "QA_DeclaratieIndienen - PostInitiateDeclarationWorkflowByEmploymentId - component 41 - 6.89",
"reasonForDeviatingFromCalculatedDistance": null,
"route": [
{
"pointOfInterest": null,
"address": {
"freeformAddress": "Teststraat 1, 1234 AB Teststad",
"countryCode": null
},
"position": {
"latitude": 52.123456,
"longitude": 4.123456
}
},
{
"pointOfInterest": null,
"address": {
"freeformAddress": "Toetslaan 2, 5678 CA Toetsstad",
"countryCode": null
},
"position": {
"latitude": 54.678912,
"longitude": 6.678912
}
}
]
}
},
"approve": {
"value": {
"description": "Approve",
"action": "fabf3b25-abf9-4e8c-a8f7-81400d1b0e96"
}
},
"reject": {
"value": {
"description": "Reject",
"action": "abc31d45-f593-4d73-8078-6caba9cebdcc"
}
},
"inputData": {
"value": {
"description": "Approve",
"action": "2c61abbf-16ce-4fe5-b333-ac0d0bb46cc9",
"input": "{\"workflowIdpayrollPeriodId\": 202409}"
}
},
"zonderDeviationOfFixedValuesList2023-05-26": {
"value": {
"totalSize": 650,
"pageSize": 250,
"totalPages": 3,
"currentPage": 2,
"version": {
"obsoleteDate": null,
"resourceVersion": "2023-05-26"
},
"messages": [
{
"type": "Warning",
"description": "",
"id": "string",
"code": 12,
"properties": [
"string"
]
}
],
"_embedded": [
{
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1,
"description": "Ouderdomspensioen"
},
"deviations": null,
"fixedContribution": null,
"vitalityScheme": {
"key": 1,
"value": "Volgens regeling"
}
}
]
}
},
"metDeviationZonderFixedValuesList2023-05-26": {
"value": {
"totalSize": 650,
"pageSize": 250,
"totalPages": 3,
"currentPage": 2,
"version": {
"obsoleteDate": null,
"resourceVersion": "2023-05-26"
},
"messages": [
{
"type": "Warning",
"description": "",
"id": "string",
"code": 12,
"properties": [
"string"
]
}
],
"_embedded": [
{
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1,
"description": "Ouderdomspensioen"
},
"deviations": {
"employmentContributionPercentage": 1,
"totalContributionPercentage": 12.0007
},
"fixedContribution": null,
"vitalityScheme": null
}
]
}
},
"zonderDeviationMetFixedValuesList2023-05-26": {
"value": {
"totalSize": 650,
"pageSize": 250,
"totalPages": 3,
"currentPage": 2,
"version": {
"obsoleteDate": null,
"resourceVersion": "2023-05-26"
},
"messages": [
{
"type": "Warning",
"description": "",
"id": "string",
"code": 12,
"properties": [
"string"
]
}
],
"_embedded": [
{
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1,
"description": "Ouderdomspensioen"
},
"deviations": null,
"fixedContribution": {
"employmentContribution": 1789,
"totalContribution": 2569
},
"vitalityScheme": {
"key": 1,
"value": "Volgens regeling"
}
}
]
}
},
"zonderDeviationOfFixedValuesList": {
"value": {
"totalSize": 650,
"pageSize": 250,
"totalPages": 3,
"currentPage": 2,
"version": {
"obsoleteDate": null,
"resourceVersion": "2018-12-31"
},
"messages": [
{
"type": "Warning",
"description": "",
"id": "string",
"code": 12,
"properties": [
"string"
]
}
],
"_embedded": [
{
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1,
"description": "Ouderdomspensioen"
},
"deviations": null,
"fixedContribution": null
}
]
}
},
"metDeviationZonderFixedValuesList": {
"value": {
"totalSize": 650,
"pageSize": 250,
"totalPages": 3,
"currentPage": 2,
"version": {
"obsoleteDate": null,
"resourceVersion": "2018-12-31"
},
"messages": [
{
"type": "Warning",
"description": "",
"id": "string",
"code": 12,
"properties": [
"string"
]
}
],
"_embedded": [
{
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1,
"description": "Ouderdomspensioen"
},
"deviations": {
"employmentContributionPercentage": 1,
"totalContributionPercentage": 12.0007
},
"fixedContribution": null
}
]
}
},
"zonderDeviationMetFixedValuesList": {
"value": {
"totalSize": 650,
"pageSize": 250,
"totalPages": 3,
"currentPage": 2,
"version": {
"obsoleteDate": null,
"resourceVersion": "2018-12-31"
},
"messages": [
{
"type": "Warning",
"description": "",
"id": "string",
"code": 12,
"properties": [
"string"
]
}
],
"_embedded": [
{
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1,
"description": "Ouderdomspensioen"
},
"deviations": null,
"fixedContribution": {
"employmentContribution": 1789,
"totalContribution": 2569
}
}
]
}
},
"postZonderDeviationOfFixedValues2023-05-26": {
"value": {
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1
},
"deviations": null,
"fixedContribution": null,
"vitalityScheme": {
"key": 1
}
}
},
"postMetDeviationZonderFixedValues2023-05-26": {
"value": {
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1
},
"deviations": {
"employmentContributionPercentage": 11,
"totalContributionPercentage": 12.0007
},
"fixedContribution": null,
"vitalityScheme": {
"key": 1
}
}
},
"postZonderDeviationMetFixedValues2023-05-26": {
"value": {
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1
},
"deviations": null,
"fixedContribution": {
"employmentContribution": 1789,
"totalContribution": 2569
},
"vitalityScheme": {
"key": 1
}
}
},
"postZonderDeviationOfFixedValues": {
"value": {
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1
},
"deviations": null,
"fixedContribution": null
}
},
"postMetDeviationZonderFixedValues": {
"value": {
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1
},
"deviations": {
"employmentContributionPercentage": 11,
"totalContributionPercentage": 12.0007
},
"fixedContribution": null
}
},
"postZonderDeviationMetFixedValues": {
"value": {
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1
},
"deviations": null,
"fixedContribution": {
"employmentContribution": 1789,
"totalContribution": 2569
}
}
},
"zonderDeviationOfFixedValuesDetail2023-05-26": {
"value": {
"version": {
"obsoleteDate": null,
"resourceVersion": "2023-05-26"
},
"messages": [
{
"type": "Warning",
"description": "",
"id": "string",
"code": 12,
"properties": [
"string"
]
}
],
"content": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1,
"description": "Ouderdomspensioen"
},
"deviations": null,
"fixedContribution": null,
"vitalityScheme": null
}
}
},
"metDeviationZonderFixedValuesDetail2023-05-26": {
"value": {
"version": {
"obsoleteDate": null,
"resourceVersion": "2023-05-26"
},
"messages": [
{
"type": "Warning",
"description": "",
"id": "string",
"code": 12,
"properties": [
"string"
]
}
],
"content": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1,
"description": "Ouderdomspensioen"
},
"deviations": {
"employmentContributionPercentage": "1.0000",
"totalContributionPercentage": "12.0007"
},
"fixedContribution": null,
"vitalityScheme": {
"key": 1,
"value": "Volgens regeling"
}
}
}
},
"zonderDeviationMetFixedValuesDetail2023-05-26": {
"value": {
"version": {
"obsoleteDate": null,
"resourceVersion": "2023-05-26"
},
"messages": [
{
"type": "Warning",
"description": "",
"id": "string",
"code": 12,
"properties": [
"string"
]
}
],
"content": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1,
"description": "Ouderdomspensioen"
},
"deviations": null,
"fixedContribution": {
"employmentContribution": "1789.00",
"totalContribution": 2569
},
"vitalityScheme": {
"key": 1,
"value": "Volgens regeling"
}
}
}
},
"zonderDeviationOfFixedValuesDetail": {
"value": {
"version": {
"obsoleteDate": null,
"resourceVersion": "2018-12-31"
},
"messages": [
{
"type": "Warning",
"description": "",
"id": "string",
"code": 12,
"properties": [
"string"
]
}
],
"content": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1,
"description": "Ouderdomspensioen"
},
"deviations": null,
"fixedContribution": null
}
}
},
"metDeviationZonderFixedValuesDetail": {
"value": {
"version": {
"obsoleteDate": null,
"resourceVersion": "2018-12-31"
},
"messages": [
{
"type": "Warning",
"description": "",
"id": "string",
"code": 12,
"properties": [
"string"
]
}
],
"content": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1,
"description": "Ouderdomspensioen"
},
"deviations": {
"employmentContributionPercentage": 1,
"totalContributionPercentage": 12.0007
},
"fixedContribution": null
}
}
},
"zonderDeviationMetFixedValuesDetail": {
"value": {
"version": {
"obsoleteDate": null,
"resourceVersion": "2018-12-31"
},
"messages": [
{
"type": "Warning",
"description": "",
"id": "string",
"code": 12,
"properties": [
"string"
]
}
],
"content": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1,
"description": "Ouderdomspensioen"
},
"deviations": null,
"fixedContribution": {
"employmentContribution": 1789,
"totalContribution": 2569
}
}
}
},
"putZonderDeviationOfFixedValues2023-05-26": {
"value": {
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"deviations": null,
"fixedContribution": null,
"vitalityScheme": {
"key": 1
}
}
},
"putMetDeviationZonderFixedValues2023-05-26": {
"value": {
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"deviations": {
"employmentContributionPercentage": 11,
"totalContributionPercentage": 12.0007
},
"fixedContribution": null,
"vitalityScheme": {
"key": 1
}
}
},
"putZonderDeviationMetFixedValues2023-05-26": {
"value": {
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"deviations": null,
"fixedContribution": {
"employmentContribution": 1789,
"totalContribution": 2569
},
"vitalityScheme": {
"key": 1
}
}
},
"putZonderDeviationOfFixedValues": {
"value": {
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"deviations": null,
"fixedContribution": null
}
},
"putMetDeviationZonderFixedValues": {
"value": {
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"deviations": {
"employmentContributionPercentage": 11,
"totalContributionPercentage": 12.0007
},
"fixedContribution": null
}
},
"putZonderDeviationMetFixedValues": {
"value": {
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"deviations": null,
"fixedContribution": {
"employmentContribution": 1789,
"totalContribution": 2569
}
}
},
"postMetDeviationZonderFixedValues-2": {
"value": {
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1
},
"deviations": {
"employmentContributionPercentage": 11,
"totalContributionPercentage": 12.007
},
"fixedContribution": null
}
},
"metDeviationZonderFixedValuesDetail-2": {
"value": {
"version": {
"obsoleteDate": null,
"resourceVersion": "2018-12-31"
},
"messages": [
{
"type": "Warning",
"description": "",
"id": "string",
"code": 12,
"properties": [
"string"
]
}
],
"content": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"fund": {
"key": 1,
"description": "Ouderdomspensioen"
},
"deviations": {
"employmentContributionPercentage": 1,
"totalContributionPercentage": 12.007
},
"fixedContribution": null
}
}
},
"putMetDeviationZonderFixedValues-2": {
"value": {
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"deviations": {
"employmentContributionPercentage": 11,
"totalContributionPercentage": 12.007
},
"fixedContribution": null
}
},
"metadata": {
"value": {
"totalSize": 3,
"pageSize": 250,
"totalPages": 1,
"currentPage": 1,
"version": {
"obsoleteDate": null,
"resourceVersion": "2018-01-01"
},
"messages": [],
"_embedded": [
{
"field": "leaveType",
"options": [
{
"key": 1,
"value": "Verlof wettelijk"
},
{
"key": 15,
"value": "Bijzonder verlof"
}
]
}
]
}
},
"defaults": {
"value": {
"version": {
"obsoleteDate": null,
"resourceVersion": "2018-01-01"
},
"messages": [],
"content": {
"id": null,
"numberOfUnits": 8,
"isAccrual": false,
"startDate": "",
"endDate": "",
"leaveType": {
"key": 1,
"value": "Verlof (bovenwettelijk)",
"balanceExceedsYear": true
},
"origin": null,
"comment": null,
"relatedLeaveRequest": null,
"relatedLeave": null
}
}
},
"metadata-2": {
"value": {
"totalSize": 4,
"pageSize": 250,
"totalPages": 1,
"currentPage": 1,
"version": {
"obsoleteDate": null,
"resourceVersion": "2018-01-01"
},
"messages": [],
"_embedded": [
{
"field": "costCenter",
"options": [
{
"id": null,
"code": null,
"description": "n.v.t.",
"linkedCostUnits": [
null
]
},
{
"id": "00000000-0000-0000-0000-000000000000",
"code": null,
"description": "Allemaal / overig",
"linkedCostUnits": [
"00000000-0000-0000-0000-000000000000"
]
}
]
},
{
"field": "costUnit",
"options": [
{
"id": null,
"code": null,
"description": "n.v.t.",
"linkedCostCenters": [
null
]
},
{
"id": "00000000-0000-0000-0000-000000000000",
"code": null,
"description": "Allemaal / overig",
"linkedCostCenters": [
"00000000-0000-0000-0000-000000000000"
]
}
]
},
{
"field": "ledgerAccount",
"options": [
{
"id": "0000067d-0019-0000-0100-000000000000",
"number": "1206010",
"description": "Aangifte Loonheffingen",
"costAccount": false
},
{
"id": "0000067d-0019-0000-0200-000000000000",
"number": "4002011",
"description": "Loonheffingen",
"costAccount": true
}
]
},
{
"field": "payrollComponent",
"options": [
{
"key": 70,
"description": "LOON/SALARIS",
"category": {
"key": 26,
"value": "Output"
}
},
{
"key": 71,
"description": "VAKANTIELOON",
"category": {
"key": 26,
"value": "Output"
}
}
]
}
]
}
}
}
},
"x-tagGroups": [
{
"name": "Base objects",
"tags": [
"Provider",
"Employer",
"Administration",
"Employment",
"Employee",
"Concept employee",
"Concept employee contact person"
]
},
{
"name": "Absence and health",
"tags": [
"Absence",
"Absence Progress",
"Contact history",
"Healthcare Insurance Act",
"Occupational disability"
]
},
{
"name": "Applicationsets",
"tags": [
"Applicationsets"
]
},
{
"name": "Assessment",
"tags": [
"Assessment"
]
},
{
"name": "Audit trail",
"tags": [
"Audit trail",
"Audit trail payroll run"
]
},
{
"name": "Authorizations",
"tags": [
"Employer user authorizations",
"Provider user authorizations",
"Authorization sets",
"Authorizations"
]
},
{
"name": "Bases for calculation",
"tags": [
"Base for employment fund calculation",
"Base for calculation",
"Collective bases for calculation",
"Collective bases for employment fund calculation"
]
},
{
"name": "Benefits",
"tags": [
"Benefit in kind type",
"Benefits and deductions",
"Benefits and deductions import",
"Social security benefits",
"Pension benefit",
"Benefit in kind",
"Collective benefits and deductions",
"Work related costs scheme"
]
},
{
"name": "Billing",
"tags": [
"Billable items",
"Billable item"
]
},
{
"name": "Collective action",
"tags": [
"Collective action"
]
},
{
"name": "Company car",
"tags": [
"Fiscal company car",
"Fiscal company car import",
"Company car"
]
},
{
"name": "Custom fields",
"tags": [
"Custom field",
"Employment custom field",
"Employee custom field"
]
},
{
"name": "Dashboard",
"tags": [
"Provider dashboard",
"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",
"Dossier report"
]
},
{
"name": "Download request",
"tags": [
"Download request"
]
},
{
"name": "Email",
"tags": [
"EmailIdentities",
"Email Identities",
"Emailtemplates",
"Event notification configuration"
]
},
{
"name": "Employer reports",
"tags": [
"Employer reports"
]
},
{
"name": "Employer settings",
"tags": [
"Contract code",
"Distribution Units",
"Employment template",
"Employer configuration",
"Employer authorization groups"
]
},
{
"name": "Employment others",
"tags": [
"Fiscal properties",
"Collective fiscal properties",
"Other payroll variables",
"Social security",
"Create employment",
"Activate employee profile",
"Actuals",
"Deviating AWF Contribution",
"Transition compensation",
"Wachtgeld",
"Signal paygrade adjustment",
"Collective signal paygrade adjustment",
"Employment reports"
]
},
{
"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 cumulative results",
"Journal run overview"
]
},
{
"name": "Function and Department",
"tags": [
"Departments",
"Functions",
"Working hours",
"Organizational entity"
]
},
{
"name": "Funds",
"tags": [
"Abp funds",
"Employment funds",
"Collective employment funds",
"Collective abp funds"
]
},
{
"name": "Imports",
"tags": [
"Employee import"
]
},
{
"name": "Journal configuration",
"tags": [
"Journal configuration",
"Journal profile provider",
"Journal profile wage model",
"Journal profile payroll administration",
"Journal application",
"Journal allocation"
]
},
{
"name": "Leave",
"tags": [
"Leave",
"Leave balance",
"Leave import",
"Leave request",
"Leave types",
"Custom holiday",
"National holiday",
"Calendar",
"Leave policy",
"Provider leave policy",
"Leave policy and employment links",
"Collective leave",
"Leave policy accrual",
"Leave policy entitlement"
]
},
{
"name": "Lookup functions",
"tags": [
"Address",
"Data New Business",
"Last modified version numbers",
"AOW date",
"Chamber of commerce",
"Location service"
]
},
{
"name": "Marketplace",
"tags": [
"Marketplace"
]
},
{
"name": "Modules",
"tags": [
"Modules",
"Module sets"
]
},
{
"name": "Non payroll administration",
"tags": [
"Non payroll administration"
]
},
{
"name": "Notes",
"tags": [
"Employer notes",
"Employment notes",
"Employee notes",
"Payroll run notes",
"Concept employee notes"
]
},
{
"name": "Notifications, announcements, etc.",
"tags": [
"Notification sets",
"Custom notification",
"Notification",
"Announcement",
"Mdv notifications",
"Provider notification settings"
]
},
{
"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",
"Smart Paste payroll period data",
"Payroll components",
"Automatic payroll configuration",
"Automatic payroll dates"
]
},
{
"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",
"Pension declaration",
"Pension wage statement"
]
},
{
"name": "Proforma",
"tags": [
"Proforma"
]
},
{
"name": "Provider",
"tags": [
"Provider configuration",
"Provider payslip configuration",
"AuthorizationModel",
"GroupClassification",
"Provider employer reports",
"Provider payroll administration reports",
"Provider reports misc"
]
},
{
"name": "Reports new style",
"tags": [
"Reports new style"
]
},
{
"name": "Self service and Preboarding",
"tags": [
"Employee self service",
"Employee self service payroll",
"Employee self service wage projection",
"Concept employee self service",
"Preboarding trajectory"
]
},
{
"name": "User provider",
"tags": [
"Provider user",
"Provider user authorization groups",
"Authorization group",
"Authorization group authorizations",
"Authorization group employers",
"Authorization group users"
]
},
{
"name": "User employer",
"tags": [
"Employer user",
"Linked departments",
"Linked employers",
"Employer user notification settings",
"User client",
"Recommended actions",
"Linked employee"
]
},
{
"name": "User",
"tags": [
"User",
"User filter settings",
"User responsibility",
"Connected applications"
]
},
{
"name": "Wage",
"tags": [
"Paygrade",
"Wage",
"Wage proposal",
"Wage projection",
"Wage import",
"Deviating hourly wage",
"Cost per hour",
"Collective wage"
]
},
{
"name": "Workflow",
"tags": [
"Workflows",
"Workflow trigger",
"Workflow template",
"Workflow trigger mapping",
"Workflow employee",
"Workflow employment",
"Workflow progress",
"Change address request",
"Change contactinformation request"
]
},
{
"name": "Year transition",
"tags": [
"Year transition"
]
}
]
}